privy_ruby 0.1.0 → 0.3.0

data/lib/privy/models/kraken_embed_start_verification_url_response.rb

@@ -6,19 +6,13 @@ module Privy
       # @!attribute result
       #   Result payload for start verification URL response.
       #
-      #   @return [Privy::Models::KrakenEmbedStartVerificationURLResponse::Result]
-      required :result, -> { Privy::KrakenEmbedStartVerificationURLResponse::Result }
+      #   @return [Privy::Models::KrakenEmbedStartVerificationURLResult, nil]
+      required :result, -> { Privy::KrakenEmbedStartVerificationURLResult }, nil?: true
 
       # @!method initialize(result:)
       #   Response body for starting verification via URL.
       #
-      #   @param result [Privy::Models::KrakenEmbedStartVerificationURLResponse::Result] Result payload for start verification URL response.
-
-      # @see Privy::Models::KrakenEmbedStartVerificationURLResponse#result
-      class Result < Privy::Models::KrakenEmbedStartVerificationURLResult
-        # @!method initialize
-        #   Result payload for start verification URL response.
-      end
+      #   @param result [Privy::Models::KrakenEmbedStartVerificationURLResult, nil] Result payload for start verification URL response.
     end
   end
 end

data/lib/privy/models/kraken_embed_transaction_status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Lifecycle status of a portfolio transaction.
+    module KrakenEmbedTransactionStatus
+      extend Privy::Internal::Type::Enum
+
+      UNSPECIFIED = :unspecified
+      IN_PROGRESS = :in_progress
+      SUCCESSFUL = :successful
+      FAILED = :failed
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_transaction_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Type of portfolio transaction in the transaction history.
+    module KrakenEmbedTransactionType
+      extend Privy::Internal::Type::Enum
+
+      SIMPLE_ORDER = :simple_order
+      SIMPLE_ORDER_FAILED = :simple_order_failed
+      EARN_REWARD = :earn_reward
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_upcoming_reward.rb

@@ -22,8 +22,8 @@ module Privy
       # @!attribute estimated_pending_amount
       #   An earn amount with native and converted values.
       #
-      #   @return [Privy::Models::KrakenEmbedUpcomingReward::EstimatedPendingAmount]
-      required :estimated_pending_amount, -> { Privy::KrakenEmbedUpcomingReward::EstimatedPendingAmount }
+      #   @return [Privy::Models::KrakenEmbedEarnAmount, nil]
+      required :estimated_pending_amount, -> { Privy::KrakenEmbedEarnAmount }, nil?: true
 
       # @!method initialize(accumulated_amount:, asset:, date:, estimated_pending_amount:)
       #   An upcoming earn reward for a specific asset.
@@ -34,13 +34,7 @@ module Privy
       #
       #   @param date [Time]
       #
-      #   @param estimated_pending_amount [Privy::Models::KrakenEmbedUpcomingReward::EstimatedPendingAmount] An earn amount with native and converted values.
-
-      # @see Privy::Models::KrakenEmbedUpcomingReward#estimated_pending_amount
-      class EstimatedPendingAmount < Privy::Models::KrakenEmbedEarnAmount
-        # @!method initialize
-        #   An earn amount with native and converted values.
-      end
+      #   @param estimated_pending_amount [Privy::Models::KrakenEmbedEarnAmount, nil] An earn amount with native and converted values.
     end
   end
 end

data/lib/privy/models/linked_account_base_wallet.rb

@@ -9,43 +9,25 @@ module Privy
       required :address, String
 
       # @!attribute chain_type
+      #   The wallet chain types that offer first class support.
       #
-      #   @return [Symbol, Privy::Models::LinkedAccountBaseWallet::ChainType]
-      required :chain_type, enum: -> { Privy::LinkedAccountBaseWallet::ChainType }
+      #   @return [Symbol, Privy::Models::FirstClassChainType]
+      required :chain_type, enum: -> { Privy::FirstClassChainType }
 
       # @!attribute type
+      #   The type of wallet linked account (external wallet or smart wallet).
       #
-      #   @return [Symbol, Privy::Models::LinkedAccountBaseWallet::Type]
-      required :type, enum: -> { Privy::LinkedAccountBaseWallet::Type }
+      #   @return [Symbol, Privy::Models::LinkedAccountBaseWalletType]
+      required :type, enum: -> { Privy::LinkedAccountBaseWalletType }
 
       # @!method initialize(address:, chain_type:, type:)
       #   Base schema for wallet accounts linked to the user.
       #
       #   @param address [String]
-      #   @param chain_type [Symbol, Privy::Models::LinkedAccountBaseWallet::ChainType]
-      #   @param type [Symbol, Privy::Models::LinkedAccountBaseWallet::Type]
-
-      # @see Privy::Models::LinkedAccountBaseWallet#chain_type
-      module ChainType
-        extend Privy::Internal::Type::Enum
-
-        SOLANA = :solana
-        ETHEREUM = :ethereum
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @see Privy::Models::LinkedAccountBaseWallet#type
-      module Type
-        extend Privy::Internal::Type::Enum
-
-        WALLET = :wallet
-        SMART_WALLET = :smart_wallet
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #
+      #   @param chain_type [Symbol, Privy::Models::FirstClassChainType] The wallet chain types that offer first class support.
+      #
+      #   @param type [Symbol, Privy::Models::LinkedAccountBaseWalletType] The type of wallet linked account (external wallet or smart wallet).
     end
   end
 end

data/lib/privy/models/linked_account_base_wallet_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # The type of wallet linked account (external wallet or smart wallet).
+    module LinkedAccountBaseWalletType
+      extend Privy::Internal::Type::Enum
+
+      WALLET = :wallet
+      SMART_WALLET = :smart_wallet
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    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/linked_account_passkey_credential_device_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # WebAuthn credential device type indicating platform or cross-platform
+    # authenticator residency.
+    module LinkedAccountPasskeyCredentialDeviceType
+      extend Privy::Internal::Type::Enum
+
+      SINGLE_DEVICE = :singleDevice
+      MULTI_DEVICE = :multiDevice
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/linked_account_passkey_input.rb

@@ -4,9 +4,11 @@ module Privy
   module Models
     class LinkedAccountPasskeyInput < Privy::Internal::Type::BaseModel
       # @!attribute credential_device_type
+      #   WebAuthn credential device type indicating platform or cross-platform
+      #   authenticator residency.
       #
-      #   @return [Symbol, Privy::Models::LinkedAccountPasskeyInput::CredentialDeviceType]
-      required :credential_device_type, enum: -> { Privy::LinkedAccountPasskeyInput::CredentialDeviceType }
+      #   @return [Symbol, Privy::Models::LinkedAccountPasskeyCredentialDeviceType]
+      required :credential_device_type, enum: -> { Privy::LinkedAccountPasskeyCredentialDeviceType }
 
       # @!attribute credential_id
       #
@@ -29,24 +31,20 @@ module Privy
       required :type, const: :passkey
 
       # @!method initialize(credential_device_type:, credential_id:, credential_public_key:, credential_username:, type: :passkey)
+      #   Some parameter documentations has been truncated, see
+      #   {Privy::Models::LinkedAccountPasskeyInput} for more details.
+      #
       #   The payload for importing a passkey account.
       #
-      #   @param credential_device_type [Symbol, Privy::Models::LinkedAccountPasskeyInput::CredentialDeviceType]
+      #   @param credential_device_type [Symbol, Privy::Models::LinkedAccountPasskeyCredentialDeviceType] WebAuthn credential device type indicating platform or cross-platform authentica
+      #
       #   @param credential_id [String]
+      #
       #   @param credential_public_key [String]
+      #
       #   @param credential_username [String]
+      #
       #   @param type [Symbol, :passkey]
-
-      # @see Privy::Models::LinkedAccountPasskeyInput#credential_device_type
-      module CredentialDeviceType
-        extend Privy::Internal::Type::Enum
-
-        SINGLE_DEVICE = :singleDevice
-        MULTI_DEVICE = :multiDevice
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/privy/models/linked_account_wallet_input.rb

@@ -9,9 +9,10 @@ module Privy
       required :address, String
 
       # @!attribute chain_type
+      #   The wallet chain types that offer first class support.
       #
-      #   @return [Symbol, Privy::Models::LinkedAccountWalletInput::ChainType]
-      required :chain_type, enum: -> { Privy::LinkedAccountWalletInput::ChainType }
+      #   @return [Symbol, Privy::Models::FirstClassChainType]
+      required :chain_type, enum: -> { Privy::FirstClassChainType }
 
       # @!attribute type
       #
@@ -22,19 +23,10 @@ module Privy
       #   The payload for importing a wallet account.
       #
       #   @param address [String]
-      #   @param chain_type [Symbol, Privy::Models::LinkedAccountWalletInput::ChainType]
+      #
+      #   @param chain_type [Symbol, Privy::Models::FirstClassChainType] The wallet chain types that offer first class support.
+      #
       #   @param type [Symbol, :wallet]
-
-      # @see Privy::Models::LinkedAccountWalletInput#chain_type
-      module ChainType
-        extend Privy::Internal::Type::Enum
-
-        ETHEREUM = :ethereum
-        SOLANA = :solana
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/privy/models/message_signing_condition.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class MessageSigningCondition < Privy::Internal::Type::BaseModel
+      # @!attribute field
+      #   Supported fields for message signing conditions.
+      #
+      #   @return [Symbol, Privy::Models::MessageSigningField]
+      required :field, enum: -> { Privy::MessageSigningField }
+
+      # @!attribute field_source
+      #
+      #   @return [Symbol, Privy::Models::MessageSigningCondition::FieldSource]
+      required :field_source, enum: -> { Privy::MessageSigningCondition::FieldSource }
+
+      # @!attribute operator
+      #   Operator to use for policy conditions.
+      #
+      #   @return [Symbol, Privy::Models::ConditionOperator]
+      required :operator, enum: -> { Privy::ConditionOperator }
+
+      # @!attribute value
+      #   Value to compare against in a policy condition. Can be a single string or an
+      #   array of strings.
+      #
+      #   @return [String, Array<String>]
+      required :value, union: -> { Privy::ConditionValue }
+
+      # @!method initialize(field:, field_source:, operator:, value:)
+      #   Some parameter documentations has been truncated, see
+      #   {Privy::Models::MessageSigningCondition} for more details.
+      #
+      #   Condition on the message being signed (e.g. in personal_sign).
+      #
+      #   @param field [Symbol, Privy::Models::MessageSigningField] Supported fields for message signing conditions.
+      #
+      #   @param field_source [Symbol, Privy::Models::MessageSigningCondition::FieldSource]
+      #
+      #   @param operator [Symbol, Privy::Models::ConditionOperator] Operator to use for policy conditions.
+      #
+      #   @param value [String, Array<String>] Value to compare against in a policy condition. Can be a single string or an arr
+
+      # @see Privy::Models::MessageSigningCondition#field_source
+      module FieldSource
+        extend Privy::Internal::Type::Enum
+
+        MESSAGE = :message
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/message_signing_field.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Supported fields for message signing conditions.
+    module MessageSigningField
+      extend Privy::Internal::Type::Enum
+
+      CONTENT = :content
+      BYTE_LENGTH = :byte_length
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/mfa_disabled_webhook_payload.rb

@@ -4,10 +4,10 @@ module Privy
   module Models
     class MfaDisabledWebhookPayload < Privy::Internal::Type::BaseModel
       # @!attribute method_
-      #   The MFA method that was disabled.
+      #   A multi-factor authentication method supported by the app.
       #
-      #   @return [Symbol, Privy::Models::MfaDisabledWebhookPayload::Method]
-      required :method_, enum: -> { Privy::MfaDisabledWebhookPayload::Method }, api_name: :method
+      #   @return [Symbol, Privy::Models::MfaMethod]
+      required :method_, enum: -> { Privy::MfaMethod }, api_name: :method
 
       # @!attribute type
       #   The type of webhook event.
@@ -24,26 +24,12 @@ module Privy
       # @!method initialize(method_:, type:, user_id:)
       #   Payload for the mfa.disabled webhook event.
       #
-      #   @param method_ [Symbol, Privy::Models::MfaDisabledWebhookPayload::Method] The MFA method that was disabled.
+      #   @param method_ [Symbol, Privy::Models::MfaMethod] A multi-factor authentication method supported by the app.
       #
       #   @param type [Symbol, Privy::Models::MfaDisabledWebhookPayload::Type] The type of webhook event.
       #
       #   @param user_id [String] The ID of the user who disabled MFA.
 
-      # The MFA method that was disabled.
-      #
-      # @see Privy::Models::MfaDisabledWebhookPayload#method_
-      module Method
-        extend Privy::Internal::Type::Enum
-
-        SMS = :sms
-        TOTP = :totp
-        PASSKEY = :passkey
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       # The type of webhook event.
       #
       # @see Privy::Models::MfaDisabledWebhookPayload#type

data/lib/privy/models/mfa_enabled_webhook_payload.rb

@@ -4,10 +4,10 @@ module Privy
   module Models
     class MfaEnabledWebhookPayload < Privy::Internal::Type::BaseModel
       # @!attribute method_
-      #   The MFA method that was enabled.
+      #   A multi-factor authentication method supported by the app.
       #
-      #   @return [Symbol, Privy::Models::MfaEnabledWebhookPayload::Method]
-      required :method_, enum: -> { Privy::MfaEnabledWebhookPayload::Method }, api_name: :method
+      #   @return [Symbol, Privy::Models::MfaMethod]
+      required :method_, enum: -> { Privy::MfaMethod }, api_name: :method
 
       # @!attribute type
       #   The type of webhook event.
@@ -24,26 +24,12 @@ module Privy
       # @!method initialize(method_:, type:, user_id:)
       #   Payload for the mfa.enabled webhook event.
       #
-      #   @param method_ [Symbol, Privy::Models::MfaEnabledWebhookPayload::Method] The MFA method that was enabled.
+      #   @param method_ [Symbol, Privy::Models::MfaMethod] A multi-factor authentication method supported by the app.
       #
       #   @param type [Symbol, Privy::Models::MfaEnabledWebhookPayload::Type] The type of webhook event.
       #
       #   @param user_id [String] The ID of the user who enabled MFA.
 
-      # The MFA method that was enabled.
-      #
-      # @see Privy::Models::MfaEnabledWebhookPayload#method_
-      module Method
-        extend Privy::Internal::Type::Enum
-
-        SMS = :sms
-        TOTP = :totp
-        PASSKEY = :passkey
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       # The type of webhook event.
       #
       # @see Privy::Models::MfaEnabledWebhookPayload#type

data/lib/privy/models/mfa_method.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # A multi-factor authentication method supported by the app.
+    module MfaMethod
+      extend Privy::Internal::Type::Enum
+
+      SMS = :sms
+      TOTP = :totp
+      PASSKEY = :passkey
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/named_token_transfer_source.rb

@@ -4,9 +4,11 @@ module Privy
   module Models
     class NamedTokenTransferSource < Privy::Internal::Type::BaseModel
       # @!attribute amount
+      #   @deprecated
+      #
       #   Amount as a decimal string in the token's standard unit (e.g. "1.5" for 1.5
-      #   USDC, "0.01" for 0.01 ETH). Not in the smallest on-chain unit (wei, lamports,
-      #   etc.). Maximum 100 characters.
+      #   USDC, "0.01" for 0.01 ETH). For exact_input, specifies the amount to send. Not
+      #   in the smallest on-chain unit (wei, lamports, etc.). Maximum 100 characters.
       #
       #   @return [String]
       required :amount, String

data/lib/privy/models/oauth_grant.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class OAuthGrant < Privy::Internal::Type::BaseModel
+      # @!attribute id
+      #   The grant identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   When the grant was first created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute grant_type
+      #   The OAuth grant type that created this grant.
+      #
+      #   @return [Symbol, Privy::Models::OAuthGrant::GrantType]
+      required :grant_type, enum: -> { Privy::OAuthGrant::GrantType }
+
+      # @!attribute last_used_at
+      #   When the grant was last used (e.g. token refreshed).
+      #
+      #   @return [Time]
+      required :last_used_at, Time
+
+      # @!method initialize(id:, created_at:, grant_type:, last_used_at:)
+      #   An active OAuth grant representing an authorized session.
+      #
+      #   @param id [String] The grant identifier.
+      #
+      #   @param created_at [Time] When the grant was first created.
+      #
+      #   @param grant_type [Symbol, Privy::Models::OAuthGrant::GrantType] The OAuth grant type that created this grant.
+      #
+      #   @param last_used_at [Time] When the grant was last used (e.g. token refreshed).
+
+      # The OAuth grant type that created this grant.
+      #
+      # @see Privy::Models::OAuthGrant#grant_type
+      module GrantType
+        extend Privy::Internal::Type::Enum
+
+        DEVICE_CODE = :device_code
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/oauth_grant_list_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class OAuthGrantListResponse < Privy::Internal::Type::BaseModel
+      # @!attribute data
+      #   Active grants.
+      #
+      #   @return [Array<Privy::Models::OAuthGrant>]
+      required :data, -> { Privy::Internal::Type::ArrayOf[Privy::OAuthGrant] }
+
+      # @!method initialize(data:)
+      #   List of active OAuth grants for the authenticated user.
+      #
+      #   @param data [Array<Privy::Models::OAuthGrant>] Active grants.
+    end
+  end
+end

data/lib/privy/models/oauth_grant_revoke_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class OAuthGrantRevokeResponse < Privy::Internal::Type::BaseModel
+      # @!attribute success
+      #   Whether the revocation was processed.
+      #
+      #   @return [Boolean, Privy::Models::OAuthGrantRevokeResponse::Success]
+      required :success, enum: -> { Privy::OAuthGrantRevokeResponse::Success }
+
+      # @!method initialize(success:)
+      #   Response from revoking an OAuth grant.
+      #
+      #   @param success [Boolean, Privy::Models::OAuthGrantRevokeResponse::Success] Whether the revocation was processed.
+
+      # Whether the revocation was processed.
+      #
+      # @see Privy::Models::OAuthGrantRevokeResponse#success
+      module Success
+        extend Privy::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+    end
+  end
+end

data/lib/privy/models/oauth_token_authorization_code_request_body.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class OAuthTokenAuthorizationCodeRequestBody < Privy::Internal::Type::BaseModel
+      # @!attribute code
+      #   The authorization code received from the authorization endpoint.
+      #
+      #   @return [String]
+      required :code, String
+
+      # @!attribute grant_type
+      #
+      #   @return [Symbol, Privy::Models::OAuthTokenAuthorizationCodeRequestBody::GrantType]
+      required :grant_type, enum: -> { Privy::OAuthTokenAuthorizationCodeRequestBody::GrantType }
+
+      # @!attribute client_id
+      #   The client ID. Alternative to Basic auth header.
+      #
+      #   @return [String, nil]
+      optional :client_id, String
+
+      # @!attribute client_secret
+      #   The client secret. Alternative to Basic auth header.
+      #
+      #   @return [String, nil]
+      optional :client_secret, String
+
+      # @!attribute redirect_uri
+      #   The redirect URI used in the authorization request.
+      #
+      #   @return [String, nil]
+      optional :redirect_uri, String
+
+      # @!method initialize(code:, grant_type:, client_id: nil, client_secret: nil, redirect_uri: nil)
+      #   Request body for the authorization_code grant type.
+      #
+      #   @param code [String] The authorization code received from the authorization endpoint.
+      #
+      #   @param grant_type [Symbol, Privy::Models::OAuthTokenAuthorizationCodeRequestBody::GrantType]
+      #
+      #   @param client_id [String] The client ID. Alternative to Basic auth header.
+      #
+      #   @param client_secret [String] The client secret. Alternative to Basic auth header.
+      #
+      #   @param redirect_uri [String] The redirect URI used in the authorization request.
+
+      # @see Privy::Models::OAuthTokenAuthorizationCodeRequestBody#grant_type
+      module GrantType
+        extend Privy::Internal::Type::Enum
+
+        AUTHORIZATION_CODE = :authorization_code
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/oauth_token_device_code_pending_error.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class OAuthTokenDeviceCodePendingError < Privy::Internal::Type::BaseModel
+      # @!attribute error
+      #   Error codes for the device authorization pending response per RFC 8628.
+      #
+      #   @return [Symbol, Privy::Models::OAuthTokenDeviceCodePendingErrorCode]
+      required :error, enum: -> { Privy::OAuthTokenDeviceCodePendingErrorCode }
+
+      # @!attribute error_description
+      #   Human-readable description of the error.
+      #
+      #   @return [String, nil]
+      optional :error_description, String
+
+      # @!attribute interval
+      #   The minimum polling interval in seconds.
+      #
+      #   @return [Float, nil]
+      optional :interval, Float
+
+      # @!method initialize(error:, error_description: nil, interval: nil)
+      #   Error response returned while the device authorization is still pending (RFC
+      #   8628 Section 3.5).
+      #
+      #   @param error [Symbol, Privy::Models::OAuthTokenDeviceCodePendingErrorCode] Error codes for the device authorization pending response per RFC 8628.
+      #
+      #   @param error_description [String] Human-readable description of the error.
+      #
+      #   @param interval [Float] The minimum polling interval in seconds.
+    end
+  end
+end