cross_platform.yaml

$schema: "https://json-schema.org/draft/2020-12/schema"
$id: "https://adapty.io/crossPlatform/3.3.3/schema"
title: "Cross Platform Format"

$requests:
  ### activate ###
  Activate.Request: #request
    type: object
    required: [method, configuration]
    properties:
      method: { const: "activate" }
      configuration: { $ref: "#/$defs/AdaptyConfiguration" }

  Activate.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### adaptyUICreateView ###
  AdaptyUICreateView.Request: #request
    type: object
    required:
      - method
      - paywall
    properties:
      method: { const: "adapty_ui_create_view" }
      paywall: { $ref: "#/$defs/AdaptyPaywall" }
      load_timeout: { type: number, description: "seconds" }
      preload_products: { type: boolean, default: false }
      custom_tags: { $ref: "#/$defs/AdaptyUI.CustomTagsValues" }
      custom_timers: { $ref: "#/$defs/AdaptyUI.CustomTimersValues" }
      android_personalized_offers:
        { $ref: "#/$defs/AdaptyUI.AndroidPersonalizedOffers" }

  AdaptyUICreateView.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { $ref: "#/$defs/AdaptyUI.View" }

  ### adaptyUIDismissView ###
  AdaptyUIDismissView.Request: #request
    type: object
    required: [method, id]
    properties:
      method: { const: "adapty_ui_dismiss_view" }
      id: { type: string, description: "View Id" }
      destroy: { type: boolean, default: false }

  AdaptyUIDismissView.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### adaptyUIPresentView ###
  AdaptyUIPresentView.Request: #request
    type: object
    required: [method, id]
    properties:
      method: { const: "adapty_ui_present_view" }
      id: { type: string, description: "View Id" }

  AdaptyUIPresentView.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### adaptyUIShowDialog ###
  AdaptyUIShowDialog.Request: #request
    type: object
    required: [method, id, configuration]
    properties:
      method: { const: "adapty_ui_show_dialog" }
      id: { type: string, description: "View Id" }
      configuration: { $ref: "#/$defs/AdaptyUI.DialogConfiguration" }

  AdaptyUIShowDialog.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { $ref: "#/$defs/AdaptyUI.DialogActionType" }

  ### getPaywall ###
  GetPaywall.Request: #request
    type: object
    required: [method, placement_id]
    properties:
      method: { const: "get_paywall" }
      placement_id: { type: string }
      locale: { $ref: "#/$defs/AdaptyLocale" }
      fetch_policy: { $ref: "#/$defs/AdaptyPaywall.FetchPolicy" }
      load_timeout: { type: number, description: "seconds" }

  GetPaywall.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { $ref: "#/$defs/AdaptyPaywall" }

    ### getPaywall ###
  GetPaywallForDefaultAudience.Request: #request
    type: object
    required: [method, placement_id]
    properties:
      method: { const: "get_paywall_for_default_audience" }
      placement_id: { type: string }
      locale: { $ref: "#/$defs/AdaptyLocale" }
      fetch_policy: { $ref: "#/$defs/AdaptyPaywall.FetchPolicy" }

  GetPaywallForDefaultAudience.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { $ref: "#/$defs/AdaptyPaywall" }

  ### getPaywallProducts ###
  GetPaywallProducts.Request: #request
    type: object
    required: [method, paywall]
    properties:
      method: { const: "get_paywall_products" }
      paywall: { $ref: "#/$defs/AdaptyPaywall" }

  GetPaywallProducts.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success:
            {
              type: array,
              items: { $ref: "#/$defs/AdaptyPaywallProduct.Response" },
            }

  ### getProfile ###
  GetProfile.Request: #request
    type: object
    required: [method]
    properties:
      method: { const: "get_profile" }

  GetProfile.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { $ref: "#/$defs/AdaptyProfile" }

  ### identify ###
  Identify.Request: #request
    type: object
    required: [method, customer_user_id]
    properties:
      method: { const: "identify" }
      customer_user_id: { type: string }

  Identify.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### isActivated ###
  IsActivated.Request: #request
    type: object
    required: [method]
    properties:
      method: { const: "is_activated" }

  IsActivated.Response: #response
    type: object
    required: [success]
    properties:
      success: { type: boolean }

  ### getLogLevel ###
  GetLogLevel.Request: #request
    type: object
    required: [method]
    properties:
      method: { const: "get_log_level" }

  GetLogLevel.Response: #response
    type: object
    required: [success]
    properties:
      success: { $ref: "#/$defs/AdaptyLog.Level" }

  ### setLogLevel ###
  SetLogLevel.Request: #request
    type: object
    required: [method, value]
    properties:
      method: { const: "set_log_level" }
      value: { $ref: "#/$defs/AdaptyLog.Level" }

  SetLogLevel.Response: #response
    type: object
    required: [success]
    properties:
      success: { const: true }

  ### logout ###
  Logout.Request: #request
    type: object
    required: [method]
    properties:
      method: { const: "logout" }

  Logout.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### logShowOnboarding ###
  LogShowOnboarding.Request: #request
    type: object
    required: [method, params]
    properties:
      method: { const: "log_show_onboarding" }
      params: { $ref: "#/$defs/AdaptyOnboardingScreenParameters" }

  LogShowOnboarding.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### logShowPaywall ###
  LogShowPaywall.Request: #request
    type: object
    required: [method, paywall]
    properties:
      method: { const: "log_show_paywall" }
      paywall: { $ref: "#/$defs/AdaptyPaywall" }

  LogShowPaywall.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### makePurchase ###
  MakePurchase.Request: #request
    type: object
    required: [method, product]
    properties:
      method: { const: "make_purchase" }
      product: { $ref: "#/$defs/AdaptyPaywallProduct.Request" }
      subscription_update_params:
        {
          $ref: "#/$defs/AdaptySubscriptionUpdateParameters",
          description: "Android Only",
        }
      is_offer_personalized: { type: boolean, description: "Android Only" }

  MakePurchase.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { $ref: "#/$defs/AdaptyPurchaseResult" }

  ### presentCodeRedemptionSheet ###
  PresentCodeRedemptionSheet.Request: #request
    type: object
    required: [method]
    properties:
      method: { const: "present_code_redemption_sheet" }

  PresentCodeRedemptionSheet.Response: #response
    type: object
    required: [success]
    properties:
      success: { const: true }

  ### reportTransaction ###
  ReportTransaction.Request: #request
    type: object
    required: [method, transaction_id]
    properties:
      method: { const: "report_transaction" }
      variation_id: { type: string }
      transaction_id: { type: string }

  ReportTransaction.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { $ref: "#/$defs/AdaptyProfile" }

  ### restorePurchases ###
  RestorePurchases.Request: #request
    type: object
    required: [method]
    properties:
      method: { const: "restore_purchases" }

  RestorePurchases.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { $ref: "#/$defs/AdaptyProfile" }

  ### getSDKVersion ###
  GetSDKVersion.Request: #request
    type: object
    required: [method]
    properties:
      method: { const: "get_sdk_version" }

  GetSDKVersion.Response: #response
    type: object
    required: [success]
    properties:
      success: { type: string }

  ### setFallbackPaywalls ###
  SetFallbackPaywalls.Request: #request
    type: object
    required: [method]
    properties:
      method: { const: "set_fallback_paywalls" }
    oneOf:
      - required: [asset_id]
        properties:
          asset_id: { type: string }
      - required: [path]
        properties:
          path: { type: string }

  SetFallbackPaywalls.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### setIntegrationIdentifier ###
  SetIntegrationIdentifier.Request: #request
    type: object
    required: [method, key_values]
    properties:
      method: { const: "set_integration_identifiers" }
      key_values:
        type: object
        additionalProperties:
          type: string
          nullable: false

  SetIntegrationIdentifier.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### updateAttributionData ###
  UpdateAttributionData.Request: #request
    type: object
    required: [method, attribution, source]
    properties:
      method: { const: "update_attribution_data" }
      attribution: { type: string }
      source: { type: string }

  UpdateAttributionData.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### updateCollectingRefundDataConsent ###
  UpdateCollectingRefundDataConsent.Request: #request
    type: object
    required: [method, consent]
    properties:
      method: { const: "update_collecting_refund_data_consent" }
      consent: { type: boolean }

  UpdateCollectingRefundDataConsent.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### updateProfile ###
  UpdateProfile.Request: #request
    type: object
    required: [method, params]
    properties:
      method: { const: "update_profile" }
      params: { $ref: "#/$defs/AdaptyProfileParameters" }

  UpdateProfile.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

  ### updateRefundPreference ###
  UpdateRefundPreference.Request: #request
    type: object
    required: [method, refund_preference]
    properties:
      method: { const: "update_refund_preference" }
      refund_preference: { $ref: "#/$defs/AdaptyRefundPreference" }

  UpdateRefundPreference.Response: #response
    type: object
    oneOf:
      - required: [error]
        properties:
          error: { $ref: "#/$defs/AdaptyError" }
      - required: [success]
        properties:
          success: { const: true }

$events:
  Event.DidLoadLatestProfile:
    type: object
    required: [id, profile]
    properties:
      id: { const: "did_load_latest_profile" }
      profile: { $ref: "#/$defs/AdaptyProfile" }

  PaywallViewEvent.DidUserAction:
    type: object
    required: [id, view, action]
    properties:
      id: { const: "paywall_view_did_perform_action" }
      view: { $ref: "#/$defs/AdaptyUI.View" }
      action: { $ref: "#/$defs/AdaptyUI.UserAction" }

  PaywallViewEvent.DidSelectProduct:
    type: object
    required: [id, view, product_id]
    properties:
      id: { const: "paywall_view_did_select_product" }
      view: { $ref: "#/$defs/AdaptyUI.View" }
      product_id: { type: string }

  PaywallViewEvent.WillPurchase:
    type: object
    required: [id, view, product]
    properties:
      id: { const: "paywall_view_did_start_purchase" }
      view: { $ref: "#/$defs/AdaptyUI.View" }
      product: { $ref: "#/$defs/AdaptyPaywallProduct.Response" }

  PaywallViewEvent.DidPurchase:
    type: object
    required: [id, view, product, purchased_result]
    properties:
      id: { const: "paywall_view_did_finish_purchase" }
      view: { $ref: "#/$defs/AdaptyUI.View" }
      product: { $ref: "#/$defs/AdaptyPaywallProduct.Response" }
      purchased_result: { $ref: "#/$defs/AdaptyPurchaseResult" }

  PaywallViewEvent.DidFailPurchase:
    type: object
    required: [id, view, product, error]
    properties:
      id: { const: "paywall_view_did_fail_purchase" }
      view: { $ref: "#/$defs/AdaptyUI.View" }
      product: { $ref: "#/$defs/AdaptyPaywallProduct.Response" }
      error: { $ref: "#/$defs/AdaptyError" }

  PaywallViewEvent.WillRestorePurchase:
    type: object
    required: [id, view]
    properties:
      id: { const: "paywall_view_did_start_restore" }
      view: { $ref: "#/$defs/AdaptyUI.View" }

  PaywallViewEvent.DidRestorePurchase:
    type: object
    required: [id, view, profile]
    properties:
      id: { const: "paywall_view_did_finish_restore" }
      view: { $ref: "#/$defs/AdaptyUI.View" }
      profile: { $ref: "#/$defs/AdaptyProfile" }

  PaywallViewEvent.DidFailRestorePurchase:
    type: object
    required: [id, view, error]
    properties:
      id: { const: "paywall_view_did_fail_restore" }
      view: { $ref: "#/$defs/AdaptyUI.View" }
      error: { $ref: "#/$defs/AdaptyError" }

  PaywallViewEvent.DidFailRendering:
    type: object
    required: [id, view, error]
    properties:
      id: { const: "paywall_view_did_fail_rendering" }
      view: { $ref: "#/$defs/AdaptyUI.View" }
      error: { $ref: "#/$defs/AdaptyError" }

  PaywallViewEvent.DidFailLoadingProducts:
    type: object
    required: [id, view, error]
    properties:
      id: { const: "paywall_view_did_fail_loading_products" }
      view: { $ref: "#/$defs/AdaptyUI.View" }
      error: { $ref: "#/$defs/AdaptyError" }

$defs:
  ### Entities ###

  AdaptyError: #response
    type: object
    required: [adapty_code, message]
    properties:
      adapty_code: { type: integer }
      message: { type: string }
      detail: { type: string }

  AdaptyLog.Level: #request #response
    type: string
    enum:
      - error
      - warn
      - info
      - verbose
      - debug

  AdaptyLocale:
    type: string
    example: "en"

  Date: #response #request
    type: string
    format: "yyyy-MM-dd'T'HH:mm:ss.SSSZ"

  AdaptyConfiguration: #request
    type: object
    required: [api_key]
    properties:
      api_key: { type: string }
      customer_user_id: { type: string }
      observer_mode: { type: boolean, default: false }
      apple_idfa_collection_disabled: { type: boolean, default: false }
      google_adid_collection_disabled: { type: boolean, default: false }
      ip_address_collection_disabled: { type: boolean, default: false }
      server_cluster: { type: string, enum: ["default", "eu"] }
      backend_base_url: { type: string }
      backend_fallback_base_url: { type: string }
      backend_configs_base_url: { type: string }
      backend_proxy_host: { type: string }
      backend_proxy_port: { type: integer }
      log_level: { $ref: "#/$defs/AdaptyLog.Level" }
      cross_platform_sdk_name: { type: string }
      cross_platform_sdk_version: { type: string }
      activate_ui: { type: boolean, dafault: false }
      media_cache:
        type: object
        properties:
          memory_storage_total_cost_limit:
            { type: integer, description: "bytes" }
          memory_storage_count_limit: { type: integer }
          disk_storage_size_limit: { type: integer, description: "bytes" }

  AdaptyPaywallProduct.Response: #response
    type: object
    required:
      - vendor_product_id
      - adapty_product_id
      - paywall_variation_id
      - paywall_ab_test_name
      - paywall_name
      - audience_name
      - localized_description
      - localized_title
      - is_family_shareable # iOS Only
      - price
    properties:
      vendor_product_id: { type: string }
      adapty_product_id: { type: string }
      paywall_variation_id: { type: string }
      paywall_ab_test_name: { type: string }
      paywall_name: { type: string }
      audience_name: { type: string }
      localized_description: { type: string }
      localized_title: { type: string }
      is_family_shareable:
        { type: boolean, default: false, description: "iOS Only" }
      region_code: { type: string }
      price: { $ref: "#/$defs/AdaptyPrice" }
      subscription: { $ref: "#/$defs/AdaptyPaywallProduct.Subscription" }
      payload_data: { type: string }

  AdaptyPrice: #response
    type: object
    required: [amount]
    properties:
      amount: { type: number }
      currency_code: { type: string }
      currency_symbol: { type: string }
      localized_string: { type: string }

  AdaptyPaywallProduct.Subscription: #response
    type: object
    required:
      - group_identifier # iOS Only
      - period
      - renewal_type # Android Only
      - base_plan_id # Android Only
    properties:
      group_identifier: { type: string, description: "iOS Only" }
      period: { $ref: "#/$defs/AdaptySubscriptionPeriod" }
      localized_period: { type: string }
      offer: { $ref: "#/$defs/AdaptySubscriptionOffer" }
      renewal_type: # Android Only
        type: string
        enum:
          - prepaid
          - autorenewable
        default: autorenewable
        description: "Android Only"
      base_plan_id: { type: string, description: "Android Only" } # Android Only

  AdaptyPaywallProduct.Request: #request
    type: object
    required:
      - vendor_product_id
      - adapty_product_id
      - paywall_variation_id
      - paywall_ab_test_name
      - paywall_name
    properties:
      vendor_product_id: { type: string }
      adapty_product_id: { type: string }
      subscription_offer_identifier:
        { $ref: "#/$defs/AdaptySubscriptionOffer.Identifier" }
      paywall_variation_id: { type: string }
      paywall_ab_test_name: { type: string }
      paywall_name: { type: string }
      payload_data: { type: string }

  AdaptySubscriptionOffer: #response
    type: object
    required:
      - offer_identifier
      - phases
    properties:
      offer_identifier: { $ref: "#/$defs/AdaptySubscriptionOffer.Identifier" }
      phases:
        type: array
        items: { $ref: "#/$defs/AdaptySubscriptionOffer.Phase" }
      offer_tags: # Android Only
        type: array
        items: { type: string }
        description: Android Only

  AdaptySubscriptionOffer.Phase:
    type: object
    required:
      - price
      - subscription_period
      - number_of_periods
      - payment_mode
    properties:
      price: { $ref: "#/$defs/AdaptyPrice" }
      number_of_periods: { type: integer }
      payment_mode: { $ref: "#/$defs/AdaptySubscriptionOffer.PaymentMode" }
      subscription_period: { $ref: "#/$defs/AdaptySubscriptionPeriod" }
      localized_subscription_period: { type: string }
      localized_number_of_periods: { type: string }

  AdaptyOnboardingScreenParameters: #request
    type: object
    required: [onboarding_screen_order]
    properties:
      onboarding_name: { type: string }
      onboarding_screen_name: { type: string }
      onboarding_screen_order: { type: integer, minimum: 1 }

  AdaptyPaywall: #request #response
    type: object
    required:
      - developer_id
      - paywall_id
      - paywall_name
      - ab_test_name
      - variation_id
      - revision
      - products
      - response_created_at
    properties:
      developer_id: { type: string }
      paywall_id: { type: string }
      paywall_name: { type: string }
      response_created_at: { type: integer }
      revision: { type: integer }
      variation_id: { type: string }
      ab_test_name: { type: string }
      remote_config: { $ref: "#/$defs/AdaptyPaywall.RemoteConfig" }
      paywall_builder: { $ref: "#/$defs/AdaptyPaywall.ViewConfiguration" }
      products:
        type: array
        items: { $ref: "#/$defs/AdaptyPaywall.ProductReference" }
      payload_data: { type: string }

  AdaptyPaywall.FetchPolicy: #request
    type: object
    oneOf:
      - required: [type]
        properties:
          type:
            type: string
            enum:
              - reload_revalidating_cache_data
              - return_cache_data_else_load
      - required: [type, max_age]
        properties:
          type:
            type: string
            const: return_cache_data_if_not_expired_else_load
          max_age:
            type: number
            description: "seconds"

  AdaptyPaywall.RemoteConfig: #request #response
    type: object
    required: [lang, data]
    properties:
      lang: { $ref: "#/$defs/AdaptyLocale" }
      data: { type: string, description: "custom JSON string" }

  AdaptyPaywall.ProductReference: #request #response
    type: object
    required:
      - vendor_product_id
      - adapty_product_id
    properties:
      vendor_product_id: { type: string }
      adapty_product_id: { type: string }
      promotional_offer_id: { type: string, description: "iOS Only" }
      win_back_offer_id: { type: string, description: "iOS Only" }
      base_plan_id: { type: string, description: "Android Only" }
      offer_id: { type: string, description: "Android Only" }

  AdaptyPaywall.ViewConfiguration:
    type: object
    required:
      - paywall_builder_id
      - lang
      # - json
    properties:
      paywall_builder_id: { type: string }
      lang: { $ref: "#/$defs/AdaptyLocale" }
      json: { type: string }

  AdaptySubscriptionPeriod: #response
    type: object
    required: [unit, number_of_units]
    properties:
      unit: { $ref: "#/$defs/AdaptySubscriptionPeriod.Unit" }
      number_of_units: { type: integer }

  AdaptySubscriptionPeriod.Unit: #response
    type: string
    enum:
      - day
      - week
      - month
      - year
      - unknown

  AdaptyProfile: #response #event
    type: object
    required:
      - profile_id
      - segment_hash
      - is_test_user
      - timestamp
    properties:
      profile_id: { type: string }
      customer_user_id: { type: string }
      segment_hash: { type: string }
      custom_attributes: { $ref: "#/$defs/AdaptyProfile.CustomAttributes" }
      paid_access_levels:
        type: object
        additionalProperties: { $ref: "#/$defs/AdaptyProfile.AccessLevel" }
      subscriptions:
        type: object
        additionalProperties: { $ref: "#/$defs/AdaptyProfile.Subscription" }
      non_subscriptions:
        type: object
        additionalProperties:
          type: array
          items: { $ref: "#/$defs/AdaptyProfile.NonSubscription" }
      timestamp: { type: integer }
      is_test_user: { type: boolean }

  AdaptyProfile.AccessLevel: #response
    type: object
    required:
      - id
      - is_active
      - vendor_product_id
      - store
      - activated_at
      - is_lifetime
      - will_renew
      - is_in_grace_period
      - is_refund
    properties:
      id: { type: string }
      is_active: { type: boolean }
      vendor_product_id: { type: string }
      store: { type: string }
      activated_at: { $ref: "#/$defs/Date" }
      renewed_at: { $ref: "#/$defs/Date" }
      expires_at: { $ref: "#/$defs/Date" }
      is_lifetime: { type: boolean }
      active_introductory_offer_type: { type: string }
      active_promotional_offer_type: { type: string }
      active_promotional_offer_id: { type: string }
      offer_id: { type: string }
      will_renew: { type: boolean }
      is_in_grace_period: { type: boolean }
      unsubscribed_at: { $ref: "#/$defs/Date" }
      billing_issue_detected_at: { $ref: "#/$defs/Date" }
      starts_at: { $ref: "#/$defs/Date" }
      cancellation_reason: { type: string }
      is_refund: { type: boolean }

  AdaptyProfile.NonSubscription: #response
    type: object
    required:
      - purchase_id
      - store
      - vendor_product_id
      - purchased_at
      - is_sandbox
      - is_refund
      - is_consumable
    properties:
      purchase_id: { type: string }
      store: { type: string }
      vendor_product_id: { type: string }
      vendor_transaction_id: { type: string }
      purchased_at: { $ref: "#/$defs/Date" }
      is_sandbox: { type: boolean }
      is_refund: { type: boolean }
      is_consumable: { type: boolean }

  AdaptyProfile.Subscription: #response
    type: object
    required:
      - store
      - vendor_product_id
      - vendor_transaction_id
      - vendor_original_transaction_id
      - is_active
      - is_lifetime
      - activated_at
      - is_in_grace_period
      - is_refund
      - is_sandbox
      - will_renew
    properties:
      store: { type: string }
      vendor_product_id: { type: string }
      vendor_transaction_id: { type: string }
      vendor_original_transaction_id: { type: string }
      is_active: { type: boolean }
      is_lifetime: { type: boolean }
      activated_at: { $ref: "#/$defs/Date" }
      renewed_at: { $ref: "#/$defs/Date" }
      expires_at: { $ref: "#/$defs/Date" }
      starts_at: { $ref: "#/$defs/Date" }
      unsubscribed_at: { $ref: "#/$defs/Date" }
      billing_issue_detected_at: { $ref: "#/$defs/Date" }
      is_in_grace_period: { type: boolean }
      is_refund: { type: boolean }
      is_sandbox: { type: boolean }
      will_renew: { type: boolean }
      active_introductory_offer_type: { type: string }
      active_promotional_offer_type: { type: string }
      active_promotional_offer_id: { type: string }
      offer_id: { type: string }
      cancellation_reason: { type: string }

  AdaptyProfile.CustomAttributes:
    type: object
    additionalProperties:
      oneOf:
        - type: string
          nullable: false
        - type: number
          format: double
          nullable: false

  AdaptyProfile.Gender: #request
    type: string
    enum:
      - f
      - m
      - o
    description: |
      * `f` - female
      * `m` - male
      * `o` - other

  AdaptyProfileParameters: #request
    type: object
    properties:
      first_name: { type: string }
      last_name: { type: string }
      gender: { $ref: "#/$defs/AdaptyProfile.Gender" }
      birthday: { type: string, format: "YYYY-MM-dd" }
      email: { type: string }
      phone_number: { type: string }
      att_status: { type: integer, description: "iOS Only" }
      custom_attributes: { $ref: "#/$defs/AdaptyProfile.CustomAttributes" }
      analytics_disabled: { type: boolean }

  AdaptySubscriptionOffer.Identifier: #request #response
    type: string
    oneOf:
      - required:
          - type
          - id # Android Only
        properties:
          id: { type: string }
          type: { type: string, const: introductory }
      - required: [id, type]
        properties:
          id: { type: string }
          type: { type: string, enum: [promotional, win_back] }

  AdaptySubscriptionOffer.PaymentMode: #response
    type: string
    enum:
      - pay_as_you_go
      - pay_up_front
      - free_trial
      - unknown

  AdaptyPurchaseResult: #response
    type: object
    oneOf:
      - required: [type]
        properties:
          type: { type: string, enum: ["pending", "user_cancelled"] }
      - required: [type, profile]
        properties:
          type: { type: string, const: "success" }
          profile: { $ref: "#/$defs/AdaptyProfile" }

  AdaptyUI.View: #response #event
    type: object
    required:
      - id
      - placement_id
      - paywall_variation_id
    properties:
      id: { type: string }
      placement_id: { type: string }
      paywall_variation_id: { type: string }

  AdaptyUI.UserAction: #event
    type: object
    oneOf:
      - required: [type]
        properties:
          type: { type: string, const: ["close", "system_back"] }
      - required: [type, value]
        properties:
          type: { type: string, enum: ["open_url", "custom"] }
          value: { type: string }

  AdaptyUI.CustomTagsValues: #request
    type: object
    additionalProperties: { type: string, nullable: false }

  AdaptyUI.CustomTimersValues: #request
    type: object
    additionalProperties: { $ref: "#/$defs/Date", nullable: false }

  AdaptyUI.AndroidPersonalizedOffers: #request
    type: object
    additionalProperties: { type: boolean, nullable: false }

  AdaptyUI.DialogConfiguration: #request
    type: object
    required: [default_action]
    properties:
      title: { type: string }
      content: { type: string }
      default_action_title: { type: string }
      secondary_action_title: { type: string }

  AdaptyUI.DialogActionType:
    type: string
    enum:
      - primary
      - secondary

  AdaptySubscriptionUpdateParameters: #request # Android Only
    type: object
    required:
      - old_sub_vendor_product_id
      - replacement_mode
    properties:
      old_sub_vendor_product_id: { type: string }
      replacement_mode:
        type: string
        enum:
          - charge_full_price
          - deferred
          - without_proration
          - charge_prorated_price
          - with_time_proration

  AdaptyRefundPreference:
    type: string
    enum:
      - no_preference
      - grant
      - decline