outerjoyn 2.0.0__py3-none-any.whl

outerjoyn/_generated/models.py

@@ -0,0 +1,1303 @@
+# generated by datamodel-codegen:
+#   filename:  sdk-api.yaml
+
+from __future__ import annotations
+
+from typing import Any, Literal, TypedDict
+
+from typing_extensions import NotRequired
+
+
+class RegisteredAddress(TypedDict):
+    line1: NotRequired[str]
+    line2: NotRequired[str]
+    city: NotRequired[str]
+    state: NotRequired[str]
+    postal_code: NotRequired[str]
+    country: NotRequired[str]
+
+
+class Stored(TypedDict):
+    legal_name: NotRequired[str]
+    registered_address: NotRequired[RegisteredAddress]
+    jurisdiction: NotRequired[str]
+    signatory_name: NotRequired[str]
+    signatory_title: NotRequired[str]
+    signatory_email: NotRequired[str]
+    source: NotRequired[Literal['manual', 'tenant_billing']]
+    updated_at: NotRequired[str]
+
+
+class Data(TypedDict):
+    brand_id: NotRequired[str]
+    legal_name: NotRequired[str]
+    address: NotRequired[str]
+    registered_address: NotRequired[RegisteredAddress]
+    jurisdiction: NotRequired[str]
+    signatory_name: NotRequired[str]
+    signatory_title: NotRequired[str]
+    signatory_email: NotRequired[str]
+    legal_source: NotRequired[Literal['legal_entity', 'tenant_billing', 'brand_name']]
+    stored: NotRequired[Stored]
+
+
+class BrandLegalEntityResponse(TypedDict):
+    data: NotRequired[Data]
+
+
+class Role(TypedDict):
+    role_id: NotRequired[str]
+    name: NotRequired[str]
+    display_name: NotRequired[str]
+    description: NotRequired[str]
+    role_type: NotRequired[str]
+    member_count: NotRequired[str]
+
+
+class FinanceErrorResponse(TypedDict):
+    error: str
+    error_code: NotRequired[str]
+    code: NotRequired[str]
+    message: NotRequired[str]
+    required_scopes: NotRequired[list[str]]
+    current_scopes: NotRequired[list[str]]
+    docs: NotRequired[str]
+
+
+class ShopifyPointsPayment(TypedDict):
+    amount: str
+    discount_codes: NotRequired[list[str]]
+
+
+class ShopifyRefundReverseRequest(TypedDict):
+    shop_domain: str
+    refund: dict[str, Any]
+
+
+class Error(TypedDict):
+    type: Literal['invalid_request_error', 'authentication_error', 'permission_error', 'rate_limit_error', 'api_error']
+    code: NotRequired[str]
+    message: str
+    param: NotRequired[str]
+    request_id: NotRequired[str]
+    doc_url: NotRequired[str]
+
+
+class ErrorResponse(TypedDict):
+    error: Error
+
+
+class IdentityHints(TypedDict):
+    email: NotRequired[str]
+    phone: NotRequired[str]
+    name: NotRequired[str]
+
+
+class CreateSessionRequest(TypedDict):
+    partner_member_id: str
+    partnership_id: NotRequired[str]
+    brand_program_id: NotRequired[str]
+    identity_hints: NotRequired[IdentityHints]
+    scopes: NotRequired[list[Literal['balance:read', 'exchange', 'redeem', 'link', 'earn', 'pay']]]
+    ttl_minutes: NotRequired[int]
+
+
+class Legal(TypedDict):
+    termsUrl: str
+    privacyUrl: str
+
+
+class LinkedProgram(TypedDict):
+    program_name: NotRequired[str]
+    currency_name: NotRequired[str]
+
+
+class MemberContext(TypedDict):
+    member_id: str
+    display_name: str
+    linked_programs: list[LinkedProgram]
+    error_simulation: NotRequired[str]
+
+
+class PayableBalance(TypedDict):
+    memberCurrencyId: str
+    currencyId: str
+    currencyName: str
+    currencyCode: str
+    brandName: str
+    brandLogoUrl: NotRequired[str]
+    balance: float
+    pointValueAmount: float
+    pointValueAmountUsd: NotRequired[float]
+    valueCents: int
+
+
+class ReservationInput(TypedDict):
+    memberCurrencyId: str
+    currencyId: str
+    pointsAmount: float
+    pointValueAmount: float
+    platformFeeCents: float
+
+
+class CouponInput(TypedDict):
+    code: str
+    definitionType: Literal['voucher', 'coupon', 'gift_card']
+    definitionId: str
+
+
+class ReservationError(TypedDict):
+    memberCurrencyId: str
+    error: str
+    code: str
+
+
+class Reservation(TypedDict):
+    reservationId: str
+    redemptionToken: str
+    pointsReserved: float
+    valueCents: int
+    pointValueAmount: float
+    status: Literal['held', 'confirmed', 'released', 'refunded']
+
+
+class SplitCheck(TypedDict):
+    orderTotalCents: int
+    pointsValueCents: int
+    cardPortionCents: int
+    overageCents: int
+    source: Literal['request', 'checkout']
+
+
+class CancelPaymentResponse(TypedDict):
+    reservationId: str
+    status: Literal['released']
+    pointsRestored: float
+    releasedAt: str
+
+
+class RefundRequest(TypedDict):
+    redemptionToken: str
+    refundAmountCents: float
+    refundPolicy: NotRequired[Literal['points_first', 'card_first', 'proportional', 'original_tender', 'points_only']]
+    merchantRefundId: NotRequired[str]
+    reason: NotRequired[str]
+
+
+class RefundResponse(TypedDict):
+    refundId: str
+    pointsRefunded: float
+    pointsRefundValueCents: int
+    cardRefundCents: int
+    newPointsBalance: float
+    remainingRefundableCents: int
+
+
+class RefundLineRef(TypedDict):
+    lineRef: str
+    quantity: NotRequired[int]
+    amountCents: NotRequired[int]
+
+
+class RefundByOrderLeg(TypedDict):
+    reservationId: str
+    redemptionToken: str
+    refundId: str
+    allocatedCents: int
+    pointsRefunded: float
+    pointsRefundValueCents: int
+    cardRefundCents: int
+    newPointsBalance: float
+    remainingRefundableCents: int
+    reversalTransactionId: NotRequired[str]
+
+
+class RefundByOrderResponse(TypedDict):
+    checkoutSessionId: str
+    merchantOrderId: NotRequired[str]
+    merchantRefundId: str
+    requestedCents: int
+    refundedCents: int
+    cardRefundCents: int
+    remainingRefundableCents: int
+    legs: list[RefundByOrderLeg]
+    lines: NotRequired[list[RefundLineRef]]
+
+
+class PaymentSession(TypedDict):
+    paymentSessionId: str
+    status: Literal['open', 'pending_fraud_review', 'confirmed', 'expired', 'cancelled']
+    merchantOrderId: str
+    orderTotalCents: float
+    totalReservedCents: int
+    createdAt: str
+    expiresAt: str
+    reservations: list[Reservation]
+
+
+class Item(TypedDict):
+    name: NotRequired[str]
+    quantity: NotRequired[int]
+    amountCents: NotRequired[int]
+
+
+class EarnRequest(TypedDict):
+    merchantOrderId: str
+    amount: int
+    currencyCode: str
+    category: NotRequired[str]
+    merchantName: NotRequired[str]
+    items: NotRequired[list[Item]]
+    metadata: NotRequired[dict[str, Any]]
+    source: NotRequired[str]
+    clickId: NotRequired[str]
+    promoCode: NotRequired[str]
+
+
+class EarnResponse(TypedDict):
+    transactionId: str
+    status: Literal['pending', 'completed']
+    amount: int
+    currencyCode: str
+    earnPending: bool
+    pointsAwarded: NotRequired[int]
+    idempotent: NotRequired[bool]
+
+
+class EarnStatus(TypedDict):
+    transactionId: str
+    status: Literal['pending', 'completed']
+    amount: int
+    currencyCode: str
+    createdAt: str
+    description: NotRequired[str]
+    merchantOrderId: NotRequired[str]
+    source: NotRequired[str]
+
+
+class Member(TypedDict):
+    member_id: str
+    first_name: str
+    last_name: str
+    tier: str
+    points_balance: float
+
+
+class ConnectedBrand(TypedDict):
+    link_id: str
+    brand_name: str
+    partner_name: str
+    linked_date: str
+    scopes: list[str]
+
+
+class Currency(TypedDict):
+    currency_id: str
+    name: str
+    code: str
+    balance: float
+    value_cents: float
+
+
+class RecentActivityItem(TypedDict):
+    date: str
+    description: str
+    amount: float
+    currency_name: str
+
+
+class AccountOverview(TypedDict):
+    member: Member
+    connected_brands: list[ConnectedBrand]
+    currencies: list[Currency]
+    recent_activity: list[RecentActivityItem]
+
+
+class MemberBalance(TypedDict):
+    points_balance: float
+    currencies: list[PayableBalance]
+
+
+class CatalogItem(TypedDict):
+    product_id: str
+    name: str
+    description: NotRequired[str]
+    sku: NotRequired[str]
+    price: NotRequired[float]
+    points_value: NotRequired[float]
+    display_url: NotRequired[str]
+    category_name: NotRequired[str]
+    brand: NotRequired[str]
+    inventory_count: NotRequired[int]
+    is_active: bool
+
+
+class CatalogPage(TypedDict):
+    items: list[CatalogItem]
+    total: int
+    page: int
+    limit: int
+
+
+class ShippingAddress(TypedDict):
+    line1: NotRequired[str]
+    line2: NotRequired[str]
+    city: NotRequired[str]
+    state: NotRequired[str]
+    postalCode: NotRequired[str]
+    country: NotRequired[str]
+
+
+class RedeemRequest(TypedDict):
+    productId: str
+    quantity: NotRequired[int]
+    shippingAddress: NotRequired[ShippingAddress]
+    metadata: NotRequired[dict[str, Any]]
+
+
+class RedeemResponse(TypedDict):
+    redemptionId: str
+    status: str
+    transactionId: NotRequired[str]
+
+
+class ExchangeRequest(TypedDict):
+    sourceCurrencyId: str
+    targetCurrencyId: str
+    sourceAmount: float
+    partnershipId: str
+    memberId: NotRequired[str]
+    idempotencyKey: NotRequired[str]
+
+
+class ExchangeResponse(TypedDict):
+    transactionId: str
+    sourceAmount: float
+    targetAmount: float
+    rate: float
+    status: Literal['completed']
+
+
+class ExchangePreview(TypedDict):
+    sourceAmount: float
+    targetAmount: float
+    rate: float
+    approvalRequired: bool
+
+
+class ExchangeRate(TypedDict):
+    exchangeRateId: str
+    sourceCurrencyId: str
+    targetCurrencyId: str
+    rate: float
+    minAmount: float
+    maxAmount: float
+    sourceName: NotRequired[str]
+    sourceCode: NotRequired[str]
+    targetName: NotRequired[str]
+    targetCode: NotRequired[str]
+
+
+class ResolvedPromotionCard(TypedDict):
+    id: str
+    title: NotRequired[str]
+    name: NotRequired[str]
+    description: NotRequired[str]
+    imageUrl: NotRequired[str]
+    startDate: NotRequired[str]
+    endDate: NotRequired[str]
+    displayEndAt: NotRequired[str]
+    category: NotRequired[str]
+    requiresEnrollment: NotRequired[bool]
+    earnRate: NotRequired[str]
+    earnRateUnit: NotRequired[str]
+    earnCapCount: NotRequired[int]
+    earnCapPeriod: NotRequired[str]
+    postingSlaDays: NotRequired[int]
+    isEnrolled: NotRequired[bool]
+    enrollmentStatus: NotRequired[Literal['active', 'completed']]
+    percentageComplete: NotRequired[float]
+    currentValue: NotRequired[float]
+    targetValue: NotRequired[float]
+
+
+class Promotion(TypedDict):
+    promotionId: str
+    name: str
+    description: NotRequired[str]
+    status: Literal['draft', 'active', 'paused', 'expired']
+    startDate: NotRequired[str]
+    endDate: NotRequired[str]
+    imageUrl: NotRequired[str]
+    terms: NotRequired[str]
+    maxEnrollments: NotRequired[int]
+    currentEnrollments: NotRequired[int]
+
+
+class EnrollmentResponse(TypedDict):
+    ok: bool
+    memberId: str
+    promotionId: str
+    enrolledAt: str
+
+
+class CreatePartnershipRequest(TypedDict):
+    platform: NotRequired[bool]
+    partner_brand_id: NotRequired[str]
+    brand_id: NotRequired[str]
+    use_case: NotRequired[str]
+    message: NotRequired[str]
+    primary_match_key: NotRequired[str]
+    terms: NotRequired[dict[str, Any]]
+
+
+class CreatePartnershipResponse(TypedDict):
+    partnership_request_id: NotRequired[str]
+    partnership_id: NotRequired[str]
+    status: str
+    created: NotRequired[bool]
+
+
+class AcceptPartnershipResponse(TypedDict):
+    partnership_id: NotRequired[str]
+    status: str
+    created: NotRequired[bool]
+
+
+class ActivatePartnershipRequest(TypedDict):
+    use_case: str
+    override_reason: NotRequired[str]
+
+
+class ActivatePartnershipResponse(TypedDict):
+    use_case_id: str
+    status: str
+    overridden: NotRequired[bool]
+    provisioning: NotRequired[list[dict[str, Any]]]
+
+
+class FundPartnershipRequest(TypedDict):
+    points: int
+    currency_id: str
+    idempotency_key: str
+    max_total_cost_cents: NotRequired[int]
+
+
+class Pool(TypedDict):
+    partner_currency_id: NotRequired[str]
+    available_balance: NotRequired[float]
+
+
+class FundPartnershipResponse(TypedDict):
+    purchase_order_id: str
+    status: str
+    pool: NotRequired[Pool]
+    batch_id: NotRequired[str]
+
+
+class FundPartnershipPendingResponse(TypedDict):
+    purchase_order_id: str
+    status: str
+    next: NotRequired[str]
+
+
+class SetPartnershipRatesRequest(TypedDict):
+    source_currency_id: str
+    target_currency_id: str
+    rate: NotRequired[float]
+
+
+class Rate(TypedDict):
+    exchange_id: NotRequired[str]
+    source_currency_id: NotRequired[str]
+    target_currency_id: NotRequired[str]
+    rate: NotRequired[float]
+    derived: NotRequired[bool]
+
+
+class SetPartnershipRatesResponse(TypedDict):
+    rates: list[Rate]
+
+
+class SetPartnershipDataSharingScopeRequest(TypedDict):
+    dsa_id: NotRequired[str]
+    approved_fields: NotRequired[dict[str, Any]]
+    brand_to_partner_config: NotRequired[dict[str, Any]]
+    partner_to_brand_config: NotRequired[dict[str, Any]]
+    selected_use_case_keys: NotRequired[list[str]]
+
+
+class Dsa(TypedDict):
+    dsa_id: NotRequired[str]
+    status: NotRequired[str]
+    approved_fields: NotRequired[dict[str, Any]]
+    brand_to_partner_config: NotRequired[dict[str, Any]]
+    partner_to_brand_config: NotRequired[dict[str, Any]]
+    selected_use_case_keys: NotRequired[list[str]]
+
+
+class SetPartnershipDataSharingScopeResponse(TypedDict):
+    dsa: Dsa
+    revision_opened: bool
+
+
+class PartnershipSummary(TypedDict):
+    id: str
+    name: NotRequired[str]
+    partnerName: NotRequired[str]
+    partnerType: NotRequired[str]
+    status: str
+    startDate: NotRequired[str]
+    linkedMembers: NotRequired[int]
+
+
+class PartnershipListResponse(TypedDict):
+    data: list[PartnershipSummary]
+    limit: int
+    offset: int
+    has_more: bool
+
+
+class PartnershipMember(TypedDict):
+    memberId: str
+    firstName: NotRequired[str]
+    lastName: NotRequired[str]
+    linkedAt: NotRequired[str]
+    status: NotRequired[str]
+
+
+class PartnershipMembersResponse(TypedDict):
+    data: list[PartnershipMember]
+    total: int
+    limit: int
+    offset: int
+    has_more: bool
+
+
+class PartnershipDetailResponse(TypedDict):
+    partnership: dict[str, Any]
+
+
+class IngestMemberRecord(TypedDict):
+    clientRef: str
+    email: NotRequired[str]
+    phone: NotRequired[str]
+    firstName: NotRequired[str]
+    lastName: NotRequired[str]
+    externalId: NotRequired[str]
+    brandRef: NotRequired[str]
+
+
+class IngestTransactionRecord(TypedDict):
+    clientRef: NotRequired[str]
+    idempotencyKey: NotRequired[str]
+    memberRef: NotRequired[str]
+    amount: NotRequired[int]
+    currency: NotRequired[str]
+    points: NotRequired[int]
+    date: NotRequired[str]
+    brandRef: NotRequired[str]
+    clickId: NotRequired[str]
+    promoCode: NotRequired[str]
+
+
+class IngestAcceptResponse(TypedDict):
+    batchId: str
+    accepted: int
+    status: str
+    statusUrl: NotRequired[str]
+
+
+class IngestBatchStatus(TypedDict):
+    batchId: str
+    objectType: str
+    status: str
+    accepted: NotRequired[int]
+    written: NotRequired[int]
+    deduped: NotRequired[int]
+    failed: NotRequired[int]
+    createdAt: NotRequired[str]
+    completedAt: NotRequired[str]
+
+
+class ApprovalDecisionRequest(TypedDict):
+    approver_user_id: str
+    reason: NotRequired[str]
+
+
+class ApprovalDecisionResponse(TypedDict):
+    status: str
+    stageStatus: NotRequired[str]
+
+
+class Data1(TypedDict):
+    deleted: bool
+
+
+class DeletedResponse(TypedDict):
+    data: Data1
+
+
+class Connection(TypedDict):
+    id: NotRequired[str]
+    ftp_id: NotRequired[str]
+    type: NotRequired[str]
+    name: NotRequired[str]
+    host: NotRequired[str]
+    protocol: NotRequired[str]
+    port: NotRequired[str]
+    username: NotRequired[str]
+    path: NotRequired[str]
+    password: NotRequired[str]
+    secret_set: NotRequired[bool]
+    business_unit_id: NotRequired[str]
+
+
+class ConnectionResponse(TypedDict):
+    data: Connection
+
+
+class ConnectionListResponse(TypedDict):
+    data: list[Connection]
+
+
+class CreateConnectionRequest(TypedDict):
+    type: Literal['ftp', 'sftp', 'database']
+    name: str
+    host: NotRequired[str]
+    port: NotRequired[int]
+    username: NotRequired[str]
+    path: NotRequired[str]
+
+
+class UpdateConnectionRequest(TypedDict):
+    pass
+
+
+class SetSecretRequest(TypedDict):
+    secret: str
+
+
+class Data2(TypedDict):
+    updated: NotRequired[bool]
+    secret_set: NotRequired[bool]
+
+
+class SetSecretResponse(TypedDict):
+    data: Data2
+
+
+class Integration(TypedDict):
+    integration_id: NotRequired[str]
+    name: NotRequired[str]
+    status: NotRequired[str]
+    job_type: NotRequired[str]
+    data_source: NotRequired[dict[str, Any]]
+    mappings: NotRequired[list[dict[str, Any]]]
+    schedule: NotRequired[dict[str, Any]]
+    business_unit_id: NotRequired[str]
+
+
+class IntegrationResponse(TypedDict):
+    data: Integration
+
+
+class IntegrationListResponse(TypedDict):
+    data: list[Integration]
+
+
+class DataSource(TypedDict):
+    type: Literal['ftp', 'sftp', 'database', 'api', 'connector', 'file_upload']
+    ftp_location_id: NotRequired[str]
+    connection_id: NotRequired[str]
+    file_path: NotRequired[str]
+    table_name: NotRequired[str]
+    endpoint: NotRequired[str]
+
+
+class CreateIntegrationRequest(TypedDict):
+    name: str
+    direction: Literal['import', 'export', 'bidirectional']
+    data_source: DataSource
+    description: NotRequired[str]
+    operation: NotRequired[str]
+    format: NotRequired[Literal['csv', 'json', 'ndjson']]
+    mappings: NotRequired[list[dict[str, Any]]]
+    schedule: NotRequired[dict[str, Any]]
+    brand_id: NotRequired[str]
+
+
+class UpdateIntegrationRequest(TypedDict):
+    status: NotRequired[Literal['active', 'paused', 'disabled']]
+
+
+class Data3(TypedDict):
+    status: str
+    job_id: NotRequired[str]
+
+
+class RunQueuedResponse(TypedDict):
+    data: Data3
+
+
+class IntegrationRun(TypedDict):
+    run_id: NotRequired[str]
+    job_id: NotRequired[str]
+    status: NotRequired[str]
+    started_at: NotRequired[str]
+    completed_at: NotRequired[str]
+    records_processed: NotRequired[str]
+    records_succeeded: NotRequired[str]
+    records_failed: NotRequired[str]
+    error_message: NotRequired[str]
+
+
+class IntegrationRunListResponse(TypedDict):
+    data: list[IntegrationRun]
+
+
+class Subscription(TypedDict):
+    kind: NotRequired[Literal['events', 'cdc']]
+    id: NotRequired[str]
+    name: NotRequired[str]
+    webhook_url: NotRequired[str]
+    is_active: NotRequired[bool]
+    event_types: NotRequired[list[str]]
+    cdc: NotRequired[dict[str, Any]]
+
+
+class SubscriptionResponse(TypedDict):
+    data: Subscription
+
+
+class SubscriptionListResponse(TypedDict):
+    data: list[Subscription]
+
+
+class CreateSubscriptionRequest(TypedDict):
+    kind: Literal['events', 'cdc']
+    webhook_url: str
+    event_types: NotRequired[list[str]]
+    object: NotRequired[str]
+    selected_fields: NotRequired[list[str]]
+
+
+class UpdateSubscriptionRequest(TypedDict):
+    webhook_url: NotRequired[str]
+    event_types: NotRequired[list[str]]
+    is_active: NotRequired[bool]
+    selected_fields: NotRequired[list[str]]
+
+
+class Data4(TypedDict):
+    subscription: Subscription
+    signing_secret: NotRequired[str]
+    signing_secret_note: NotRequired[str]
+
+
+class CreateSubscriptionResponse(TypedDict):
+    data: Data4
+
+
+class Data5(TypedDict):
+    signing_secret: NotRequired[str]
+    signing_secret_note: NotRequired[str]
+
+
+class RotateSecretResponse(TypedDict):
+    data: Data5
+
+
+class SubscriptionDelivery(TypedDict):
+    id: NotRequired[str]
+    event_type: NotRequired[str]
+    status: NotRequired[str]
+    attempt_number: NotRequired[int]
+    response_status_code: NotRequired[int]
+    error_message: NotRequired[str]
+    attempted_at: NotRequired[str]
+    delivered_at: NotRequired[str]
+    created_at: NotRequired[str]
+
+
+class SubscriptionDeliveryListResponse(TypedDict):
+    data: list[SubscriptionDelivery]
+
+
+class CreateExportRequest(TypedDict):
+    object: str
+    format: NotRequired[Literal['csv', 'json', 'ndjson']]
+    fields: NotRequired[list[str]]
+    filters: NotRequired[dict[str, Any]]
+
+
+class Data6(TypedDict):
+    status: str
+    export_id: str
+
+
+class CreateExportResponse(TypedDict):
+    data: Data6
+
+
+class Part(TypedDict):
+    part: NotRequired[int]
+    url: NotRequired[str]
+
+
+class Download(TypedDict):
+    manifest_url: NotRequired[str]
+    parts: NotRequired[list[Part]]
+
+
+class Data7(TypedDict):
+    export_id: NotRequired[str]
+    status: NotRequired[Literal['queued', 'processing', 'completed', 'failed']]
+    object: NotRequired[str]
+    format: NotRequired[str]
+    sink: NotRequired[str]
+    rows_exported: NotRequired[int]
+    parts_written: NotRequired[int]
+    error_message: NotRequired[str]
+    started_at: NotRequired[str]
+    completed_at: NotRequired[str]
+    expires_at: NotRequired[str]
+    download: NotRequired[Download]
+
+
+class ExportStatusResponse(TypedDict):
+    data: Data7
+
+
+class Task(TypedDict):
+    task_id: NotRequired[str]
+    name: NotRequired[str]
+    status: NotRequired[str]
+    task_type: NotRequired[str]
+    owner: NotRequired[str]
+    is_required: NotRequired[bool]
+    guidance_md: NotRequired[str]
+    action_url: NotRequired[str]
+
+
+class TaskListResponse(TypedDict):
+    data: list[Task]
+    use_case_id: NotRequired[str]
+    partnership_id: NotRequired[str]
+
+
+class TaskResponse(TypedDict):
+    data: Task
+    completed: NotRequired[bool]
+    already_completed: NotRequired[bool]
+
+
+class Data8(TypedDict):
+    event_subscription_id: NotRequired[str]
+    event_publisher_configs: NotRequired[list[dict[str, Any]]]
+
+
+class TaskIntegrationResponse(TypedDict):
+    data: Data8
+
+
+class Data9(TypedDict):
+    landing_page_id: NotRequired[str]
+    name: NotRequired[str]
+    task_id: NotRequired[str]
+
+
+class TaskLandingPageResponse(TypedDict):
+    data: Data9
+
+
+class PaymentTerm(TypedDict):
+    payment_term_id: NotRequired[str]
+    name: NotRequired[str]
+    payer: NotRequired[str]
+    is_active: NotRequired[bool]
+
+
+class PaymentTermListResponse(TypedDict):
+    data: list[PaymentTerm]
+    use_case_id: NotRequired[str]
+
+
+class PaymentTermResponse(TypedDict):
+    data: PaymentTerm
+
+
+class NestedListResponse(TypedDict):
+    data: list[dict[str, Any]]
+
+
+class NestedItemResponse(TypedDict):
+    data: dict[str, Any]
+
+
+class ApiKeySummary(TypedDict):
+    id: NotRequired[str]
+    name: NotRequired[str]
+    key_prefix: NotRequired[str]
+    key_display_suffix: NotRequired[str]
+    is_test: NotRequired[bool]
+    scopes: NotRequired[list[str]]
+    rate_limit_tier: NotRequired[str]
+    is_active: NotRequired[bool]
+    expires_at: NotRequired[str]
+    last_used_at: NotRequired[str]
+    description: NotRequired[str]
+    created_at: NotRequired[str]
+
+
+class ApiKeyListResponse(TypedDict):
+    data: list[ApiKeySummary]
+    has_more: NotRequired[bool]
+    total: NotRequired[int]
+
+
+class ApiKeyResponse(TypedDict):
+    data: ApiKeySummary
+
+
+class Data10(TypedDict):
+    id: NotRequired[str]
+    name: NotRequired[str]
+    key: NotRequired[str]
+    key_prefix: NotRequired[str]
+    is_test: NotRequired[bool]
+    scopes: NotRequired[list[str]]
+    warning: NotRequired[str]
+
+
+class ApiKeyMintResponse(TypedDict):
+    data: Data10
+
+
+class Data11(TypedDict):
+    id: NotRequired[str]
+    old_key_id: NotRequired[str]
+    key: NotRequired[str]
+    key_prefix: NotRequired[str]
+    warning: NotRequired[str]
+
+
+class ApiKeyRotateResponse(TypedDict):
+    data: Data11
+
+
+class Data12(TypedDict):
+    id: NotRequired[str]
+    revoked: NotRequired[bool]
+
+
+class ApiKeyRevokeResponse(TypedDict):
+    data: Data12
+
+
+class Data13(TypedDict):
+    winner_contact_id: NotRequired[str]
+    merged_contact_id: NotRequired[str]
+    members_moved: NotRequired[int]
+    already_merged: NotRequired[bool]
+
+
+class ContactMergeResponse(TypedDict):
+    data: Data13
+
+
+class ObjectSummary(TypedDict):
+    name: NotRequired[str]
+    table_name: NotRequired[str]
+    kind: NotRequired[str]
+    writable: NotRequired[bool]
+    read_scope: NotRequired[str]
+    write_scope: NotRequired[str]
+    primary_key: NotRequired[str]
+
+
+class ObjectListResponse(TypedDict):
+    objects: list[ObjectSummary]
+    business_unit_id: NotRequired[str]
+
+
+class ObjectFieldDescriptor(TypedDict):
+    column: NotRequired[str]
+    api_name: NotRequired[str]
+    type: NotRequired[str]
+    nullable: NotRequired[bool]
+    foreign_key_table: NotRequired[str]
+
+
+class ObjectDescribeResponse(TypedDict):
+    name: NotRequired[str]
+    table_name: NotRequired[str]
+    writable: NotRequired[bool]
+    read_scope: NotRequired[str]
+    write_scope: NotRequired[str]
+    primary_key: NotRequired[str]
+    fields: NotRequired[list[ObjectFieldDescriptor]]
+    custom_fields: NotRequired[list[str]]
+    business_unit_id: NotRequired[str]
+
+
+class GenericListResponse(TypedDict):
+    data: list[dict[str, Any]]
+    has_more: NotRequired[bool]
+    next_cursor: NotRequired[str]
+
+
+class GenericItemResponse(TypedDict):
+    data: dict[str, Any]
+
+
+class AccountNode(TypedDict):
+    accountId: NotRequired[str]
+    parentAccountId: NotRequired[str]
+    accountName: NotRequired[str]
+    depth: NotRequired[int]
+
+
+class AccountHierarchyResponse(TypedDict):
+    accountId: NotRequired[str]
+    ancestors: NotRequired[list[AccountNode]]
+    descendants: NotRequired[list[AccountNode]]
+
+
+class AccountParentResponse(TypedDict):
+    success: NotRequired[bool]
+    accountId: NotRequired[str]
+    parentAccountId: NotRequired[str]
+
+
+class AccountClearParentResponse(TypedDict):
+    success: NotRequired[bool]
+    accountId: NotRequired[str]
+
+
+class GroupMember(TypedDict):
+    memberId: NotRequired[str]
+    firstName: NotRequired[str]
+    lastName: NotRequired[str]
+    status: NotRequired[str]
+
+
+class AccountMembershipResponse(TypedDict):
+    accountId: NotRequired[str]
+    corpMemberId: NotRequired[str]
+    groupMembers: NotRequired[list[GroupMember]]
+
+
+class AccountEnrollResponse(TypedDict):
+    accountId: NotRequired[str]
+    memberId: NotRequired[str]
+    memberType: NotRequired[str]
+    created: NotRequired[bool]
+
+
+class ContactAssignResponse(TypedDict):
+    success: NotRequired[bool]
+    contactId: NotRequired[str]
+    accountId: NotRequired[str]
+
+
+class ContactUnassignResponse(TypedDict):
+    success: NotRequired[bool]
+    contactId: NotRequired[str]
+
+
+class FraudRuleWriteRequest(TypedDict):
+    rule_name: NotRequired[str]
+    rule_type: NotRequired[str]
+    threshold_count: NotRequired[int]
+    threshold_amount: NotRequired[float]
+    time_window_minutes: NotRequired[int]
+    time_window_hours: NotRequired[int]
+    cooldown_minutes: NotRequired[int]
+    action: NotRequired[Literal['flag', 'review', 'block']]
+    severity: NotRequired[Literal['low', 'medium', 'high', 'critical']]
+    auto_suspend_member: NotRequired[bool]
+    evaluation_mode: NotRequired[Literal['inline', 'async']]
+    is_enabled: NotRequired[bool]
+    brand_ids: NotRequired[list[str]]
+    config: NotRequired[dict[str, Any]]
+
+
+class FraudRule(TypedDict):
+    fraud_rule_id: NotRequired[str]
+    business_unit_id: NotRequired[str]
+    brand_id: NotRequired[str]
+    brand_ids: NotRequired[list[str]]
+    rule_name: NotRequired[str]
+    rule_type: NotRequired[str]
+    is_enabled: NotRequired[bool]
+    config: NotRequired[dict[str, Any]]
+
+
+class FraudRuleListRow(FraudRule):
+    trigger_count_24h: NotRequired[int]
+
+
+class FraudRuleListResponse(TypedDict):
+    data: list[FraudRuleListRow]
+    total: int
+    limit: int
+    offset: int
+    has_more: bool
+    configured_rule_types: NotRequired[list[str]]
+    scope: NotRequired[str]
+
+
+class FraudRuleResponse(TypedDict):
+    data: FraudRule
+
+
+class Data14(TypedDict):
+    fraud_rule_id: NotRequired[str]
+    deleted: NotRequired[bool]
+
+
+class FraudRuleDeleteResponse(TypedDict):
+    data: Data14
+
+
+class BatchSubRequest(TypedDict):
+    id: NotRequired[str]
+    method: Literal['GET', 'POST', 'PUT', 'PATCH', 'DELETE']
+    path: str
+    body: NotRequired[Any]
+    depends_on: NotRequired[list[str]]
+
+
+class BatchRequest(TypedDict):
+    requests: list[BatchSubRequest]
+    stop_on_error: NotRequired[bool]
+
+
+class BatchSubResult(TypedDict):
+    index: int
+    id: NotRequired[str]
+    success: bool
+    status: int
+    body: NotRequired[Any]
+    error: NotRequired[Any]
+
+
+class BatchResponse(TypedDict):
+    batch_id: str
+    total: int
+    succeeded: int
+    failed: int
+    transactional: bool
+    results: list[BatchSubResult]
+
+
+class ChangeFeedRecord(TypedDict):
+    cursor: str
+    object: str
+    record_id: str
+    operation: str
+    changed_fields: NotRequired[list[str]]
+    data: NotRequired[dict[str, Any]]
+    occurred_at: NotRequired[str]
+
+
+class Data15(TypedDict):
+    changes: list[ChangeFeedRecord]
+    next_cursor: str
+    has_more: bool
+
+
+class ChangeFeedResponse(TypedDict):
+    data: Data15
+
+
+class ShopifyOrderEarnRequest(TypedDict):
+    shop_domain: str
+    order: dict[str, Any]
+    points_payment: NotRequired[ShopifyPointsPayment]
+
+
+class CreateSessionResponse(TypedDict):
+    token: str
+    status: Literal['active', 'ready', 'link_required']
+    expires_at: str
+    member_context: MemberContext
+    payable_balances: list[PayableBalance]
+    legal: Legal
+
+
+class SessionContext(TypedDict):
+    status: Literal['active', 'link_required', 'expired']
+    member_id: str
+    display_name: str
+    business_unit_id: str
+    scopes: list[str]
+    expires_at: str
+    payable_balances: list[PayableBalance]
+    displayCurrency: NotRequired[str]
+    fxRateAsOf: NotRequired[str]
+
+
+class CheckoutRequest(TypedDict):
+    merchantOrderId: str
+    orderTotalCents: float
+    currencyCode: str
+    maxPointsApplicableCents: NotRequired[int]
+    applicationMode: NotRequired[Literal['discount', 'tender', 'coupon']]
+    merchandiseSubtotalCents: NotRequired[int]
+    taxCents: NotRequired[int]
+    shippingCents: NotRequired[int]
+    coupon: NotRequired[CouponInput]
+    refundPolicy: NotRequired[Literal['points_first', 'card_first', 'proportional', 'original_tender', 'points_only']]
+    idempotencyKey: NotRequired[str]
+    metadata: NotRequired[dict[str, Any]]
+    reservations: list[ReservationInput]
+
+
+class CheckoutResponse(TypedDict):
+    paymentSessionId: str
+    status: Literal['open']
+    expiresAt: str
+    reservations: list[Reservation]
+    totalReservedCents: int
+
+
+class CheckoutFraudHoldResponse(TypedDict):
+    paymentSessionId: str
+    status: Literal['pending_fraud_review']
+    message: str
+    fraudEventId: str
+    expiresAt: str
+    reservations: list[Reservation]
+    errors: NotRequired[list[ReservationError]]
+    totalReserved: int
+
+
+class ConfirmPaymentResponse(TypedDict):
+    reservationId: str
+    status: Literal['confirmed']
+    confirmedAt: str
+    splitCheck: NotRequired[SplitCheck]
+
+
+class RefundByOrderRequest(TypedDict):
+    merchantOrderId: NotRequired[str]
+    checkoutSessionId: NotRequired[str]
+    amountCents: float
+    merchantRefundId: str
+    kind: NotRequired[Literal['cancellation', 'return']]
+    reason: NotRequired[str]
+    refundPolicy: NotRequired[Literal['points_first', 'card_first', 'proportional', 'original_tender', 'points_only']]
+    lines: NotRequired[list[RefundLineRef]]
+
+
+class PromotionSetResolved(TypedDict):
+    id: str
+    name: str
+    description: NotRequired[str]
+    promotions: list[ResolvedPromotionCard]
+    displaySettings: NotRequired[dict[str, Any]]
+    isPublished: NotRequired[bool]
+    status: NotRequired[str]
+    meta: NotRequired[dict[str, Any]]