privy_ruby 0.0.2 → 0.2.0

data/lib/privy/models/earn_incentive_reward_entry.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class EarnIncentiveRewardEntry < Privy::Internal::Type::BaseModel
+      # @!attribute amount_claimed
+      #   Total amount already claimed, in smallest unit.
+      #
+      #   @return [String]
+      required :amount_claimed, String
+
+      # @!attribute amount_unclaimed
+      #   Amount available to claim on-chain but not yet claimed, in smallest unit.
+      #
+      #   @return [String]
+      required :amount_unclaimed, String
+
+      # @!attribute token_address
+      #   Address of the reward token.
+      #
+      #   @return [String]
+      required :token_address, String
+
+      # @!attribute token_symbol
+      #   Symbol of the reward token (e.g. "MORPHO").
+      #
+      #   @return [String]
+      required :token_symbol, String
+
+      # @!attribute token_decimals
+      #   Number of decimals for the reward token.
+      #
+      #   @return [Integer, nil]
+      optional :token_decimals, Integer
+
+      # @!method initialize(amount_claimed:, amount_unclaimed:, token_address:, token_symbol:, token_decimals: nil)
+      #   A reward token with claimed and unclaimed amounts.
+      #
+      #   @param amount_claimed [String] Total amount already claimed, in smallest unit.
+      #
+      #   @param amount_unclaimed [String] Amount available to claim on-chain but not yet claimed, in smallest unit.
+      #
+      #   @param token_address [String] Address of the reward token.
+      #
+      #   @param token_symbol [String] Symbol of the reward token (e.g. "MORPHO").
+      #
+      #   @param token_decimals [Integer] Number of decimals for the reward token.
+    end
+  end
+end

data/lib/privy/models/earn_incentive_rewards_query.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class EarnIncentiveRewardsQuery < Privy::Internal::Type::BaseModel
+      # @!attribute chain
+      #   Chain name to fetch rewards for (e.g. "base", "ethereum").
+      #
+      #   @return [String]
+      required :chain, String
+
+      # @!method initialize(chain:)
+      #   Query parameters for fetching incentive rewards.
+      #
+      #   @param chain [String] Chain name to fetch rewards for (e.g. "base", "ethereum").
+    end
+  end
+end

data/lib/privy/models/earn_incentive_rewards_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class EarnIncentiveRewardsResponse < Privy::Internal::Type::BaseModel
+      # @!attribute rewards
+      #   Reward tokens with their claimed and unclaimed amounts.
+      #
+      #   @return [Array<Privy::Models::EarnIncentiveRewardEntry>]
+      required :rewards, -> { Privy::Internal::Type::ArrayOf[Privy::EarnIncentiveRewardEntry] }
+
+      # @!method initialize(rewards:)
+      #   All incentive rewards for a wallet, with claimed and unclaimed amounts per
+      #   token.
+      #
+      #   @param rewards [Array<Privy::Models::EarnIncentiveRewardEntry>] Reward tokens with their claimed and unclaimed amounts.
+    end
+  end
+end

data/lib/privy/models/evm_address.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    EvmAddress = String
+  end
+end

data/lib/privy/models/evm_checksum_address.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    EvmChecksumAddress = String
+  end
+end

data/lib/privy/models/exchange_stripe_tokens_input.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class ExchangeStripeTokensInput < Privy::Internal::Type::BaseModel
+      # @!attribute auth_intent_id
+      #
+      #   @return [String]
+      required :auth_intent_id, String
+
+      # @!attribute crypto_customer_id
+      #
+      #   @return [String]
+      required :crypto_customer_id, String
+
+      # @!method initialize(auth_intent_id:, crypto_customer_id:)
+      #   Input for exchanging a Link auth intent for OAuth tokens.
+      #
+      #   @param auth_intent_id [String]
+      #   @param crypto_customer_id [String]
+    end
+  end
+end

data/lib/privy/models/exchange_stripe_tokens_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class ExchangeStripeTokensResponse < Privy::Internal::Type::BaseModel
+      # @!attribute crypto_customer_id
+      #
+      #   @return [String]
+      required :crypto_customer_id, String
+
+      # @!method initialize(crypto_customer_id:)
+      #   Confirmation that tokens were exchanged and stored.
+      #
+      #   @param crypto_customer_id [String]
+    end
+  end
+end

data/lib/privy/models/fiat_onramp_provider.rb

@@ -12,6 +12,8 @@ module Privy
       MOONPAY_SANDBOX = :"moonpay-sandbox"
       COINBASE = :coinbase
       COINBASE_SANDBOX = :"coinbase-sandbox"
+      STRIPE = :stripe
+      STRIPE_SANDBOX = :"stripe-sandbox"
 
       # @!method self.values
       #   @return [Array<Symbol>]

data/lib/privy/models/fiat_onramp_stripe_sdk_session_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class FiatOnrampStripeSDKSessionResponse < Privy::Internal::Type::BaseModel
+      # @!attribute network
+      #
+      #   @return [String]
+      required :network, String
+
+      # @!attribute publishable_key
+      #
+      #   @return [String]
+      required :publishable_key, String
+
+      # @!attribute session_id
+      #
+      #   @return [String]
+      required :session_id, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Privy::Models::FiatOnrampStripeSDKSessionResponse::Type]
+      required :type, enum: -> { Privy::FiatOnrampStripeSDKSessionResponse::Type }
+
+      # @!method initialize(network:, publishable_key:, session_id:, type:)
+      #   Provider session initialization for embedded SDK providers (Stripe).
+      #
+      #   @param network [String]
+      #   @param publishable_key [String]
+      #   @param session_id [String]
+      #   @param type [Symbol, Privy::Models::FiatOnrampStripeSDKSessionResponse::Type]
+
+      # @see Privy::Models::FiatOnrampStripeSDKSessionResponse#type
+      module Type
+        extend Privy::Internal::Type::Enum
+
+        STRIPE_SDK = :"stripe-sdk"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/fiat_onramp_url_session_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class FiatOnrampURLSessionResponse < Privy::Internal::Type::BaseModel
+      # @!attribute session_id
+      #
+      #   @return [String]
+      required :session_id, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Privy::Models::FiatOnrampURLSessionResponse::Type]
+      required :type, enum: -> { Privy::FiatOnrampURLSessionResponse::Type }
+
+      # @!attribute url
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(session_id:, type:, url:)
+      #   Provider session initialization for popup-based providers.
+      #
+      #   @param session_id [String]
+      #   @param type [Symbol, Privy::Models::FiatOnrampURLSessionResponse::Type]
+      #   @param url [String]
+
+      # @see Privy::Models::FiatOnrampURLSessionResponse#type
+      module Type
+        extend Privy::Internal::Type::Enum
+
+        URL = :url
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/gas.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class Gas < Privy::Internal::Type::BaseModel
+      # @!attribute amount
+      #   Gas cost in the gas token as a human-readable decimal string (e.g. "0.0001").
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute base_amount
+      #   Gas cost in the gas token's base units (e.g. wei).
+      #
+      #   @return [String]
+      required :base_amount, String
+
+      # @!attribute gas_asset
+      #   Gas token symbol (e.g. "ETH", "USDC").
+      #
+      #   @return [String]
+      required :gas_asset, String
+
+      # @!method initialize(amount:, base_amount:, gas_asset:)
+      #   Gas cost for a blockchain action. Includes both raw base-unit amount and a
+      #   human-readable decimal string, plus the gas token symbol.
+      #
+      #   @param amount [String] Gas cost in the gas token as a human-readable decimal string (e.g. "0.0001").
+      #
+      #   @param base_amount [String] Gas cost in the gas token's base units (e.g. wei).
+      #
+      #   @param gas_asset [String] Gas token symbol (e.g. "ETH", "USDC").
+    end
+  end
+end

data/lib/privy/models/get_fiat_onramp_url_response.rb

@@ -2,22 +2,20 @@
 
 module Privy
   module Models
-    class GetFiatOnrampURLResponse < Privy::Internal::Type::BaseModel
-      # @!attribute session_id
-      #
-      #   @return [String]
-      required :session_id, String
+    # Provider session initialization — either a hosted URL or embedded SDK config.
+    module GetFiatOnrampURLResponse
+      extend Privy::Internal::Type::Union
 
-      # @!attribute url
-      #
-      #   @return [String]
-      required :url, String
+      discriminator :type
 
-      # @!method initialize(session_id:, url:)
-      #   The response containing a fiat onramp provider session URL.
-      #
-      #   @param session_id [String]
-      #   @param url [String]
+      # Provider session initialization for popup-based providers.
+      variant :url, -> { Privy::FiatOnrampURLSessionResponse }
+
+      # Provider session initialization for embedded SDK providers (Stripe).
+      variant :"stripe-sdk", -> { Privy::FiatOnrampStripeSDKSessionResponse }
+
+      # @!method self.variants
+      #   @return [Array(Privy::Models::FiatOnrampURLSessionResponse, Privy::Models::FiatOnrampStripeSDKSessionResponse)]
     end
   end
 end

data/lib/privy/models/get_stripe_crypto_customer_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class GetStripeCryptoCustomerResponse < Privy::Internal::Type::BaseModel
+      # @!attribute data
+      #   Active onramp session with customer verifications.
+      #
+      #   @return [Privy::Models::StripeCryptoCustomerActive, Privy::Models::StripeCryptoCustomerExpired, Privy::Models::StripeCryptoCustomerNone]
+      required :data, union: -> { Privy::GetStripeCryptoCustomerResponse::Data }
+
+      # @!method initialize(data:)
+      #   Stripe onramp session status and customer verification info.
+      #
+      #   @param data [Privy::Models::StripeCryptoCustomerActive, Privy::Models::StripeCryptoCustomerExpired, Privy::Models::StripeCryptoCustomerNone] Active onramp session with customer verifications.
+
+      # Active onramp session with customer verifications.
+      #
+      # @see Privy::Models::GetStripeCryptoCustomerResponse#data
+      module Data
+        extend Privy::Internal::Type::Union
+
+        discriminator :status
+
+        # Active onramp session with customer verifications.
+        variant :active, -> { Privy::StripeCryptoCustomerActive }
+
+        # Expired onramp session. Token refresh failed, re-authentication required.
+        variant :expired, -> { Privy::StripeCryptoCustomerExpired }
+
+        # No onramp session. User must authenticate via Link.
+        variant :none, -> { Privy::StripeCryptoCustomerNone }
+
+        # @!method self.variants
+        #   @return [Array(Privy::Models::StripeCryptoCustomerActive, Privy::Models::StripeCryptoCustomerExpired, Privy::Models::StripeCryptoCustomerNone)]
+      end
+    end
+  end
+end

data/lib/privy/models/hyperliquid_token_address.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    HyperliquidTokenAddress = String
+  end
+end

data/lib/privy/models/kraken_embed_custom_order_cancelled_webhook_payload.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class KrakenEmbedCustomOrderCancelledWebhookPayload < Privy::Internal::Type::BaseModel
+      # @!attribute cancelled_at
+      #   ISO 8601 timestamp of when the custom order was cancelled.
+      #
+      #   @return [String]
+      required :cancelled_at, String
+
+      # @!attribute custom_order_id
+      #   The ID of the cancelled custom order.
+      #
+      #   @return [String]
+      required :custom_order_id, String
+
+      # @!attribute reason
+      #   A human-readable description of why the custom order was cancelled. Intended for
+      #   display and logging purposes only.
+      #
+      #   @return [String]
+      required :reason, String
+
+      # @!attribute type
+      #   The type of webhook event.
+      #
+      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderCancelledWebhookPayload::Type]
+      required :type, enum: -> { Privy::KrakenEmbedCustomOrderCancelledWebhookPayload::Type }
+
+      # @!attribute user_id
+      #   The ID of the user.
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(cancelled_at:, custom_order_id:, reason:, type:, user_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Privy::Models::KrakenEmbedCustomOrderCancelledWebhookPayload} for more details.
+      #
+      #   Payload for the kraken_embed.custom_order.cancelled webhook event.
+      #
+      #   @param cancelled_at [String] ISO 8601 timestamp of when the custom order was cancelled.
+      #
+      #   @param custom_order_id [String] The ID of the cancelled custom order.
+      #
+      #   @param reason [String] A human-readable description of why the custom order was cancelled. Intended for
+      #
+      #   @param type [Symbol, Privy::Models::KrakenEmbedCustomOrderCancelledWebhookPayload::Type] The type of webhook event.
+      #
+      #   @param user_id [String] The ID of the user.
+
+      # The type of webhook event.
+      #
+      # @see Privy::Models::KrakenEmbedCustomOrderCancelledWebhookPayload#type
+      module Type
+        extend Privy::Internal::Type::Enum
+
+        KRAKEN_EMBED_CUSTOM_ORDER_CANCELLED = :"kraken_embed.custom_order.cancelled"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/kraken_embed_custom_order_executed_webhook_payload.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class KrakenEmbedCustomOrderExecutedWebhookPayload < Privy::Internal::Type::BaseModel
+      # @!attribute custom_order_id
+      #   The ID of the executed custom order.
+      #
+      #   @return [String]
+      required :custom_order_id, String
+
+      # @!attribute executed_at
+      #   ISO 8601 timestamp of when the custom order was executed.
+      #
+      #   @return [String]
+      required :executed_at, String
+
+      # @!attribute type
+      #   The type of webhook event.
+      #
+      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderExecutedWebhookPayload::Type]
+      required :type, enum: -> { Privy::KrakenEmbedCustomOrderExecutedWebhookPayload::Type }
+
+      # @!attribute user_id
+      #   The ID of the user.
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(custom_order_id:, executed_at:, type:, user_id:)
+      #   Payload for the kraken_embed.custom_order.executed webhook event.
+      #
+      #   @param custom_order_id [String] The ID of the executed custom order.
+      #
+      #   @param executed_at [String] ISO 8601 timestamp of when the custom order was executed.
+      #
+      #   @param type [Symbol, Privy::Models::KrakenEmbedCustomOrderExecutedWebhookPayload::Type] The type of webhook event.
+      #
+      #   @param user_id [String] The ID of the user.
+
+      # The type of webhook event.
+      #
+      # @see Privy::Models::KrakenEmbedCustomOrderExecutedWebhookPayload#type
+      module Type
+        extend Privy::Internal::Type::Enum
+
+        KRAKEN_EMBED_CUSTOM_ORDER_EXECUTED = :"kraken_embed.custom_order.executed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/kraken_embed_custom_order_execution_failed_webhook_payload.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class KrakenEmbedCustomOrderExecutionFailedWebhookPayload < Privy::Internal::Type::BaseModel
+      # @!attribute custom_order_id
+      #   The ID of the custom order that failed to execute.
+      #
+      #   @return [String]
+      required :custom_order_id, String
+
+      # @!attribute failed_at
+      #   ISO 8601 timestamp of when the custom order execution failed.
+      #
+      #   @return [String]
+      required :failed_at, String
+
+      # @!attribute reason
+      #   A human-readable description of why the custom order execution failed. Intended
+      #   for display and logging purposes only.
+      #
+      #   @return [String]
+      required :reason, String
+
+      # @!attribute type
+      #   The type of webhook event.
+      #
+      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderExecutionFailedWebhookPayload::Type]
+      required :type, enum: -> { Privy::KrakenEmbedCustomOrderExecutionFailedWebhookPayload::Type }
+
+      # @!attribute user_id
+      #   The ID of the user.
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(custom_order_id:, failed_at:, reason:, type:, user_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Privy::Models::KrakenEmbedCustomOrderExecutionFailedWebhookPayload} for more
+      #   details.
+      #
+      #   Payload for the kraken_embed.custom_order.execution_failed webhook event.
+      #
+      #   @param custom_order_id [String] The ID of the custom order that failed to execute.
+      #
+      #   @param failed_at [String] ISO 8601 timestamp of when the custom order execution failed.
+      #
+      #   @param reason [String] A human-readable description of why the custom order execution failed. Intended
+      #
+      #   @param type [Symbol, Privy::Models::KrakenEmbedCustomOrderExecutionFailedWebhookPayload::Type] The type of webhook event.
+      #
+      #   @param user_id [String] The ID of the user.
+
+      # The type of webhook event.
+      #
+      # @see Privy::Models::KrakenEmbedCustomOrderExecutionFailedWebhookPayload#type
+      module Type
+        extend Privy::Internal::Type::Enum
+
+        KRAKEN_EMBED_CUSTOM_ORDER_EXECUTION_FAILED = :"kraken_embed.custom_order.execution_failed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/link_auth_intent_created.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class LinkAuthIntentCreated < Privy::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Link auth intent ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Privy::Models::LinkAuthIntentCreated::Status]
+      required :status, enum: -> { Privy::LinkAuthIntentCreated::Status }
+
+      # @!method initialize(id:, status:)
+      #   Auth intent created. Pass id to authenticate().
+      #
+      #   @param id [String] The Link auth intent ID.
+      #
+      #   @param status [Symbol, Privy::Models::LinkAuthIntentCreated::Status]
+
+      # @see Privy::Models::LinkAuthIntentCreated#status
+      module Status
+        extend Privy::Internal::Type::Enum
+
+        CREATED = :created
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/link_auth_intent_no_account.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class LinkAuthIntentNoAccount < Privy::Internal::Type::BaseModel
+      # @!attribute status
+      #
+      #   @return [Symbol, Privy::Models::LinkAuthIntentNoAccount::Status]
+      required :status, enum: -> { Privy::LinkAuthIntentNoAccount::Status }
+
+      # @!method initialize(status:)
+      #   No Link account for this email. Call registerLinkUser() then retry.
+      #
+      #   @param status [Symbol, Privy::Models::LinkAuthIntentNoAccount::Status]
+
+      # @see Privy::Models::LinkAuthIntentNoAccount#status
+      module Status
+        extend Privy::Internal::Type::Enum
+
+        NO_ACCOUNT = :no_account
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/linked_account_embedded_wallet.rb

@@ -2,6 +2,7 @@
 
 module Privy
   module Models
+    # A linked embedded wallet account across all supported chain types.
     module LinkedAccountEmbeddedWallet
       extend Privy::Internal::Type::Union
 

data/lib/privy/models/list_stripe_consumer_wallets_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class ListStripeConsumerWalletsResponse < Privy::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Privy::Models::StripeConsumerWallet>]
+      required :data, -> { Privy::Internal::Type::ArrayOf[Privy::StripeConsumerWallet] }
+
+      # @!method initialize(data:)
+      #   List of registered wallets for a crypto customer.
+      #
+      #   @param data [Array<Privy::Models::StripeConsumerWallet>]
+    end
+  end
+end

data/lib/privy/models/list_stripe_payment_tokens_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class ListStripePaymentTokensResponse < Privy::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Privy::Models::StripePaymentToken>]
+      required :data, -> { Privy::Internal::Type::ArrayOf[Privy::StripePaymentToken] }
+
+      # @!method initialize(data:)
+      #   List of payment tokens for a crypto customer.
+      #
+      #   @param data [Array<Privy::Models::StripePaymentToken>]
+    end
+  end
+end