pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/types/create_subscription_response.py

@@ -0,0 +1,146 @@
+# 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 .bank_account import BankAccount
+from .create_subscription_response_allowed_payment_methods_item import (
+    CreateSubscriptionResponseAllowedPaymentMethodsItem,
+)
+from .create_subscription_response_integration_mode import CreateSubscriptionResponseIntegrationMode
+from .create_subscription_response_payment_mode import CreateSubscriptionResponsePaymentMode
+from .create_subscription_response_status import CreateSubscriptionResponseStatus
+from .plan_response import PlanResponse
+from .subscription_amount import SubscriptionAmount
+
+
+class CreateSubscriptionResponse(UniversalBaseModel):
+    """
+    Response returned after creating a subscription.
+    """
+
+    callback_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to redirect customers after payment.
+    """
+
+    failure_callback_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL for failed transaction redirection.
+    """
+
+    redirect_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL for redirection after checkout.
+    """
+
+    order_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the order in the Pine Labs Online database.
+    """
+
+    subscription_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the subscription in the Pine Labs Online database.
+    """
+
+    merchant_subscription_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the merchant subscription reference.
+    """
+
+    enable_notification: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if notifications are enabled.
+    """
+
+    plan_details: typing.Optional[PlanResponse] = None
+    quantity: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The quantity of the subscription for the selected plan.
+    """
+
+    start_date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The ISO 8601 UTC Timestamp when the subscription starts.
+    """
+
+    end_date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The ISO 8601 UTC Timestamp when the subscription expires.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the customer.
+    """
+
+    payment_mode: typing.Optional[CreateSubscriptionResponsePaymentMode] = pydantic.Field(default=None)
+    """
+    Payment methods allowed for subscription.
+    """
+
+    allowed_payment_methods: typing.Optional[typing.List[CreateSubscriptionResponseAllowedPaymentMethodsItem]] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The type of payment methods offered to customers.
+    """
+
+    integration_mode: typing.Optional[CreateSubscriptionResponseIntegrationMode] = pydantic.Field(default=None)
+    """
+    Type of integration.
+    """
+
+    merchant_metadata: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
+    """
+    Key-value pairs for additional information.
+    """
+
+    status: typing.Optional[CreateSubscriptionResponseStatus] = pydantic.Field(default=None)
+    """
+    Status of the Subscription.
+    - CREATED: Subscription created but not yet active.
+    - TRIAL: In trial period before regular billing starts.
+    - ACTIVE: Currently active and payments being processed.
+    - PAUSED: Temporarily paused.
+    - RESUMING: Transitioning from PAUSED/HALTED to RESUMED.
+    - RESUMED: Resumed after being paused or halted.
+    - DEBIT_FAILED: Scheduled payment failed.
+    - UPDATING: Details are currently being modified.
+    - COMPLETED: Successfully completed billing cycle.
+    - EXPIRED: Reached end date and expired.
+    - CANCELLED: Canceled and no longer active.
+    - CANCELLING: Cancellation in progress.
+    - HALTED: Stopped due to an issue or external intervention.
+    - INACTIVE: Created but not yet activated.
+    """
+
+    is_tpv_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if Third-Party Validation (TPV) is enabled.
+    """
+
+    bank_account: typing.Optional[BankAccount] = None
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC Timestamp when the subscription was created.
+    """
+
+    modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC Timestamp when the subscription was last updated.
+    """
+
+    order_amount: typing.Optional[SubscriptionAmount] = 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_subscription_response_allowed_payment_methods_item.py

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

pinelabs/types/create_subscription_response_integration_mode.py

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

pinelabs/types/create_subscription_response_payment_mode.py

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

pinelabs/types/create_subscription_response_status.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateSubscriptionResponseStatus = typing.Union[
+    typing.Literal[
+        "CREATED",
+        "TRIAL",
+        "ACTIVE",
+        "PAUSED",
+        "RESUMING",
+        "RESUMED",
+        "DEBIT_FAILED",
+        "UPDATING",
+        "COMPLETED",
+        "EXPIRED",
+        "CANCELLED",
+        "CANCELLING",
+        "HALTED",
+        "INACTIVE",
+    ],
+    typing.Any,
+]

pinelabs/types/cryptogram_response.py

@@ -0,0 +1,39 @@
+# 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 .token_transactional_data import TokenTransactionalData
+
+
+class CryptogramResponse(UniversalBaseModel):
+    """
+    Response object containing the generated cryptogram data.
+    """
+
+    token_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Token ID used for the cryptogram generation.
+    """
+
+    merchant_token_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Merchant's token reference.
+    """
+
+    service_provider_token_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Service provider token identifier.
+    """
+
+    token_data: typing.Optional[TokenTransactionalData] = 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/currency_conversion_response.py

@@ -0,0 +1,56 @@
+# 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 CurrencyConversionResponse(UniversalBaseModel):
+    """
+    Response from the Currency Conversion API.
+    """
+
+    source_currency: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Numeric ISO 4217 source currency code.
+    """
+
+    dest_currency: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Numeric ISO 4217 destination currency code.
+    """
+
+    invoice_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Invoice reference from the request.
+    """
+
+    conversion_rate: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Rate used to convert source to destination currency.
+    """
+
+    converted_amount: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Final amount after conversion and exponent adjustment.
+    """
+
+    transaction_amount: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Original transaction amount.
+    """
+
+    converted_exponent: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of decimal places applied during conversion.
+    """
+
+    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/customer_details.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 .address import Address
+
+
+class CustomerDetails(UniversalBaseModel):
+    """
+    Customer information.
+    """
+
+    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 registered mobile number. Defaults to 91.
+    """
+
+    billing_address: typing.Optional[Address] = None
+    shipping_address: typing.Optional[Address] = None
+    is_edit_customer_details_allowed: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the customer is allowed to edit their 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/customer_response.py

@@ -0,0 +1,83 @@
+# 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 .address import Address
+from .customer_response_status import CustomerResponseStatus
+from .merchant_metadata import MerchantMetadata
+
+
+class CustomerResponse(UniversalBaseModel):
+    """
+    Customer profile response object.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the customer in the Pine Labs Online database.
+    """
+
+    merchant_customer_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier entered while creating the customer.
+    """
+
+    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.
+    """
+
+    country_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Country code of the registered mobile number.
+    """
+
+    mobile_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Customer's mobile number.
+    """
+
+    email_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Customer's email address.
+    """
+
+    billing_address: typing.Optional[Address] = None
+    shipping_address: typing.Optional[Address] = None
+    gstin: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Customer's unique GSTIN.
+    """
+
+    merchant_metadata: typing.Optional[MerchantMetadata] = None
+    status: typing.Optional[CustomerResponseStatus] = pydantic.Field(default=None)
+    """
+    Customer status.
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the customer was created.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the customer 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/customer_response_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CustomerResponseStatus = typing.Union[typing.Literal["INACTIVE", "ACTIVE", "SUSPENDED", "DELETED"], typing.Any]

pinelabs/types/customer_token_detail.py

@@ -0,0 +1,74 @@
+# 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 .customer_token_detail_payment_method import CustomerTokenDetailPaymentMethod
+from .merchant_metadata import MerchantMetadata
+from .token_card_data import TokenCardData
+from .token_status import TokenStatus
+
+
+class CustomerTokenDetail(UniversalBaseModel):
+    """
+    Individual token detail linked to a customer.
+    """
+
+    token_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique token ID generated by Pine Labs Online.
+    """
+
+    merchant_token_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Merchant's token reference.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the customer.
+    """
+
+    status: typing.Optional[TokenStatus] = None
+    payment_method: typing.Optional[CustomerTokenDetailPaymentMethod] = pydantic.Field(default=None)
+    """
+    Payment method associated with the token.
+    """
+
+    expired_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the token expires.
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the token was created.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the token was last updated.
+    """
+
+    status_reason: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Reason for the current token status.
+    """
+
+    merchant_metadata: typing.Optional[MerchantMetadata] = None
+    card_data: typing.Optional[TokenCardData] = None
+    is_compliant: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the token is compliant with regulatory requirements.
+    """
+
+    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/customer_token_detail_payment_method.py

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

pinelabs/types/customer_tokens_response.py

@@ -0,0 +1,48 @@
+# 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 .customer_token_detail import CustomerTokenDetail
+
+
+class CustomerTokensResponse(UniversalBaseModel):
+    """
+    Response object containing all tokens linked to a customer.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the customer.
+    """
+
+    total_tokens: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total number of tokens linked to the customer.
+    """
+
+    tokens: typing.Optional[typing.List[CustomerTokenDetail]] = pydantic.Field(default=None)
+    """
+    List of tokens associated with the customer.
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the customer record was created.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the customer record 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/delete_customer_token_response.py

@@ -0,0 +1,41 @@
+# 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 DeleteCustomerTokenResponse(UniversalBaseModel):
+    """
+    Response after successfully deleting a customer token.
+    """
+
+    token_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Token ID that was deleted.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the customer.
+    """
+
+    status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status of the token after deletion.
+    """
+
+    merchant_unique_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique reference for this delete operation.
+    """
+
+    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/delete_token_by_token_id_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
+
+
+class DeleteTokenByTokenIdResponse(UniversalBaseModel):
+    """
+    Response after deleting a token by its token ID.
+    """
+
+    token_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Token ID that was deleted.
+    """
+
+    status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Token status after deletion.
+    """
+
+    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/downpayment_details_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 .downpayment_details_response_downpayment_details import DownpaymentDetailsResponseDownpaymentDetails
+
+
+class DownpaymentDetailsResponse(UniversalBaseModel):
+    """
+    Response containing down payment range and milestone details.
+    """
+
+    downpayment_details: typing.Optional[DownpaymentDetailsResponseDownpaymentDetails] = pydantic.Field(default=None)
+    """
+    Down payment calculation 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