Source code for autumn.models.response

from typing import List, Optional

from pydantic import BaseModel

from .customers import Customer, PricingTableProduct
from .env import AppEnv
from .features import FeaturePreview
from .meta import FeatureOptions, QueryDP
from .products import FreeTrial, Product, ProductItem, ProductPreview

__all__ = ("AttachResponse", "CheckResponse")



[docs]
class AttachResponse(BaseModel):
    customer_id: str
    code: str = "No code returned."
    message: str
    checkout_url: Optional[str] = None
    product_ids: List[str]
    success: Optional[bool] = None




[docs]
class CheckResponse(BaseModel):
    allowed: bool
    customer_id: str
    code: str
    balance: Optional[float] = None
    feature_id: Optional[str] = None
    product_id: Optional[str] = None
    status: Optional[str] = None
    feature_preview: Optional[FeaturePreview] = None
    product_preview: Optional[ProductPreview] = None




[docs]
class TrackResponse(BaseModel):
    id: str
    code: str
    customer_id: str
    feature_id: Optional[str] = None
    event_name: Optional[str] = None




[docs]
class UsageResponse(BaseModel):
    code: str
    customer_id: str
    feature_id: str



class BillingPortalResponse(BaseModel):
    url: str
    customer_id: str



[docs]
class CreateProductResponse(BaseModel):
    created_at: int
    id: str
    name: str
    env: AppEnv
    version: int
    is_add_on: bool
    is_default: bool
    items: List[ProductItem]
    free_trial: Optional[FreeTrial] = None



GetProductResponse = CreateProductResponse



[docs]
class ReferralCodeResponse(BaseModel):
    code: str
    customer_id: str
    created_at: int



class ReferralRedeemResponse(BaseModel):
    id: str
    customer_id: str
    reward_id: str



[docs]
class CancelResponse(BaseModel):
    success: bool
    customer_id: str
    product_id: str




[docs]
class PricingTableResponse(BaseModel):
    list: List[PricingTableProduct]




[docs]
class CheckoutLine(BaseModel):
    description: str
    amount: float
    item: ProductItem




[docs]
class CheckoutNextCycle(BaseModel):
    starts_at: int
    total: float




[docs]
class CheckoutResponse(BaseModel):
    url: Optional[str] = None
    customer_id: str
    has_prorations: bool
    lines: List[CheckoutLine]
    total: float
    currency: str
    options: List[FeatureOptions]
    product: Optional[Product] = None
    current_product: Optional[Product] = None
    next_cycle: Optional[CheckoutNextCycle] = None




[docs]
class ListProductResponse(BaseModel):
    list: List[Product]




[docs]
class ListCustomerResponse(BaseModel):
    list: List[Customer]
    total: int
    limit: int
    offset: int




[docs]
class QueryResponse(BaseModel):
    list: List[QueryDP]




[docs]
class TransferProductResponse(BaseModel):
    success: bool