pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/types/plan_response.py

@@ -0,0 +1,96 @@
+# 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 .plan_response_frequency import PlanResponseFrequency
+from .plan_response_status import PlanResponseStatus
+from .subscription_amount import SubscriptionAmount
+
+
+class PlanResponse(UniversalBaseModel):
+    """
+    Plan object returned in create, get, and update responses.
+    """
+
+    plan_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the subscription plan in the Pine Labs database.
+    """
+
+    status: typing.Optional[PlanResponseStatus] = pydantic.Field(default=None)
+    """
+    Status of the plan.
+    - ACTIVE: Plan creation completed and start time has passed.
+    - INACTIVE: Plan is disabled or has exceeded its validity period.
+    - CREATED: Plan creation completed but start time is in the future.
+    """
+
+    plan_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Subscription plan name.
+    """
+
+    plan_description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Corresponding description for a plan.
+    """
+
+    frequency: typing.Optional[PlanResponseFrequency] = pydantic.Field(default=None)
+    """
+    Frequency of recurring transactions for this particular plan.
+    """
+
+    amount: typing.Optional[SubscriptionAmount] = None
+    max_limit_amount: typing.Optional[SubscriptionAmount] = None
+    trial_period_in_days: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Duration of the trial period in days.
+    """
+
+    start_date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The ISO 8601 UTC Timestamp when the subscription plan is active.
+    """
+
+    end_date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The ISO 8601 UTC Timestamp when the subscription plan expires.
+    """
+
+    merchant_metadata: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
+    """
+    Key-value pairs for additional information. Max 10 pairs, 256 chars each.
+    """
+
+    merchant_plan_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the merchant plan reference.
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC Timestamp when the create plan request was received.
+    """
+
+    modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC Timestamp when the plan was last updated.
+    """
+
+    initial_debit_amount: typing.Optional[SubscriptionAmount] = None
+    auto_debit_ot: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Indicates whether auto-debit is enabled for one-time payments.
+    """
+
+    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/plan_response_frequency.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PlanResponseFrequency = typing.Union[
+    typing.Literal[
+        "Day", "Week", "Month", "Year", "Bi-Monthly", "Quarterly", "Half-Yearly", "AS", "OT", "Not Applicable"
+    ],
+    typing.Any,
+]

pinelabs/types/plan_response_status.py

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

pinelabs/types/presentation_detail.py

@@ -0,0 +1,82 @@
+# 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 .presentation_detail_pdn_status import PresentationDetailPdnStatus
+from .presentation_detail_status import PresentationDetailStatus
+from .subscription_amount import SubscriptionAmount
+
+
+class PresentationDetail(UniversalBaseModel):
+    """
+    Presentation detail returned in get responses.
+    """
+
+    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.
+    """
+
+    pdn_status: typing.Optional[PresentationDetailPdnStatus] = pydantic.Field(default=None)
+    """
+    Pre-debit notification status.
+    - CREATED: Pine Labs received the pre-debit notification request.
+    - INITIATED: Pre-debit notification request sent to the Bank.
+    - NOTIFIED: Notification delivered successfully.
+    - FAILED: Notification delivery attempt unsuccessful.
+    - CANCELLED: Notification stopped before completion.
+    - PAUSED: Notification temporarily halted.
+    - PDN_FAILED: Pre-debit notification failed after all retry attempts.
+    """
+
+    status: typing.Optional[PresentationDetailStatus] = pydantic.Field(default=None)
+    """
+    Presentation status.
+    - CREATED: Customer Debit request received.
+    - PENDING: Debit request sent to Bank, awaiting response.
+    - COMPLETED: Debit successfully received.
+    - FAILED: Debit request unsuccessful.
+    - CANCELLED: Cancel Subscription request received.
+    - PAUSED: Pause subscription request received.
+    - PARTIALLY_REFUNDED: Partial refund successful.
+    - REFUNDED: Full refund successful.
+    - INITIATED: Debit request initiated.
+    """
+
+    failure_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The number of times the requests to execute mandates at banks have failed.
+    """
+
+    order_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the order created for this presentation.
+    """
+
+    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/presentation_detail_pdn_status.py

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

pinelabs/types/presentation_detail_status.py

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

pinelabs/types/product_detail.py

@@ -0,0 +1,38 @@
+# 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 ProductDetail(UniversalBaseModel):
+    """
+    Product details for offer discovery and validation.
+    """
+
+    product_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Product code or SKU.
+    """
+
+    product_amount: typing.Optional[Amount] = None
+    product_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the product.
+    """
+
+    product_quantity: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Quantity of the product.
+    """
+
+    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/refund_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 .refund_response_data import RefundResponseData
+
+
+class RefundResponse(UniversalBaseModel):
+    """
+    Response returned after creating a refund.
+    """
+
+    data: typing.Optional[RefundResponseData] = 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/refund_response_data.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
+from .payment_object import PaymentObject
+from .refund_response_data_integration_mode import RefundResponseDataIntegrationMode
+from .refund_response_data_order_amount import RefundResponseDataOrderAmount
+from .refund_response_data_purchase_details import RefundResponseDataPurchaseDetails
+from .refund_response_data_status import RefundResponseDataStatus
+from .refund_response_data_type import RefundResponseDataType
+
+
+class RefundResponseData(UniversalBaseModel):
+    order_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the refund order.
+    """
+
+    parent_order_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the parent order being refunded.
+    """
+
+    merchant_order_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Merchant reference for the refund.
+    """
+
+    type: typing.Optional[RefundResponseDataType] = pydantic.Field(default=None)
+    """
+    Payment type.
+    """
+
+    status: typing.Optional[RefundResponseDataStatus] = pydantic.Field(default=None)
+    """
+    Refund status.
+    """
+
+    merchant_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the merchant.
+    """
+
+    order_amount: typing.Optional[RefundResponseDataOrderAmount] = None
+    purchase_details: typing.Optional[RefundResponseDataPurchaseDetails] = None
+    payments: typing.Optional[typing.List[PaymentObject]] = None
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the refund was created.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the refund was last updated.
+    """
+
+    integration_mode: typing.Optional[RefundResponseDataIntegrationMode] = pydantic.Field(default=None)
+    """
+    Mode of implementation.
+    """
+
+    payment_retries_remaining: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Remaining payment retry attempts.
+    """
+
+    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/refund_response_data_integration_mode.py

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

pinelabs/types/refund_response_data_order_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 RefundResponseDataOrderAmount(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/refund_response_data_purchase_details.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 .merchant_metadata import MerchantMetadata
+from .refund_response_data_purchase_details_customer import RefundResponseDataPurchaseDetailsCustomer
+from .refund_response_data_purchase_details_split_info import RefundResponseDataPurchaseDetailsSplitInfo
+
+
+class RefundResponseDataPurchaseDetails(UniversalBaseModel):
+    customer: typing.Optional[RefundResponseDataPurchaseDetailsCustomer] = None
+    merchant_metadata: typing.Optional[MerchantMetadata] = None
+    split_info: typing.Optional[RefundResponseDataPurchaseDetailsSplitInfo] = 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/refund_response_data_purchase_details_customer.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 .address import Address
+
+
+class RefundResponseDataPurchaseDetailsCustomer(UniversalBaseModel):
+    email_id: typing.Optional[str] = None
+    first_name: typing.Optional[str] = None
+    last_name: typing.Optional[str] = None
+    customer_id: typing.Optional[str] = None
+    mobile_number: typing.Optional[str] = None
+    country_code: typing.Optional[str] = None
+    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/refund_response_data_purchase_details_split_info.py

@@ -0,0 +1,21 @@
+# 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 .split_detail_refund import SplitDetailRefund
+
+
+class RefundResponseDataPurchaseDetailsSplitInfo(UniversalBaseModel):
+    split_type: typing.Optional[str] = None
+    split_details: typing.Optional[typing.List[SplitDetailRefund]] = 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/refund_response_data_status.py

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

pinelabs/types/refund_response_data_type.py

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

pinelabs/types/resend_otp_error_response.py

@@ -0,0 +1,36 @@
+# 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 ResendOtpErrorResponse(UniversalBaseModel):
+    """
+    Error response when OTP resend limit is reached.
+    """
+
+    code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error code.
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message.
+    """
+
+    next: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    List of next possible actions.
+    """
+
+    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/service_provider_token_response.py

@@ -0,0 +1,62 @@
+# 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 .service_provider_token_response_payment_method import ServiceProviderTokenResponsePaymentMethod
+from .token_card_data import TokenCardData
+from .token_status import TokenStatus
+
+
+class ServiceProviderTokenResponse(UniversalBaseModel):
+    """
+    Response object containing service provider token information.
+    """
+
+    token_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique token ID generated by Pine Labs Online.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the customer.
+    """
+
+    merchant_token_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Merchant's token reference.
+    """
+
+    status: typing.Optional[TokenStatus] = None
+    payment_method: typing.Optional[ServiceProviderTokenResponsePaymentMethod] = pydantic.Field(default=None)
+    """
+    Payment method associated with the token.
+    """
+
+    card_data: typing.Optional[TokenCardData] = None
+    service_provider_token_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Service provider token identifier.
+    """
+
+    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.
+    """
+
+    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/service_provider_token_response_payment_method.py

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

pinelabs/types/service_provider_tokens_list_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 .service_provider_token_response import ServiceProviderTokenResponse
+
+
+class ServiceProviderTokensListResponse(UniversalBaseModel):
+    """
+    Response containing a list of service provider tokens for a customer.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the customer.
+    """
+
+    tokens: typing.Optional[typing.List[ServiceProviderTokenResponse]] = pydantic.Field(default=None)
+    """
+    List of service provider tokens.
+    """
+
+    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