privy_ruby 0.0.2 → 0.2.0

data/rbi/privy/models/oauth_grant.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Privy
+  module Models
+    class OAuthGrant < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Privy::OAuthGrant, Privy::Internal::AnyHash) }
+
+      # The grant identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # When the grant was first created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The OAuth grant type that created this grant.
+      sig { returns(Privy::OAuthGrant::GrantType::OrSymbol) }
+      attr_accessor :grant_type
+
+      # When the grant was last used (e.g. token refreshed).
+      sig { returns(Time) }
+      attr_accessor :last_used_at
+
+      # An active OAuth grant representing an authorized session.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          grant_type: Privy::OAuthGrant::GrantType::OrSymbol,
+          last_used_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The grant identifier.
+        id:,
+        # When the grant was first created.
+        created_at:,
+        # The OAuth grant type that created this grant.
+        grant_type:,
+        # When the grant was last used (e.g. token refreshed).
+        last_used_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            grant_type: Privy::OAuthGrant::GrantType::OrSymbol,
+            last_used_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The OAuth grant type that created this grant.
+      module GrantType
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Privy::OAuthGrant::GrantType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DEVICE_CODE =
+          T.let(:device_code, Privy::OAuthGrant::GrantType::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Privy::OAuthGrant::GrantType::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/oauth_grant_list_response.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Privy
+  module Models
+    class OAuthGrantListResponse < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Privy::OAuthGrantListResponse, Privy::Internal::AnyHash)
+        end
+
+      # Active grants.
+      sig { returns(T::Array[Privy::OAuthGrant]) }
+      attr_accessor :data
+
+      # List of active OAuth grants for the authenticated user.
+      sig do
+        params(data: T::Array[Privy::OAuthGrant::OrHash]).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Active grants.
+        data:
+      )
+      end
+
+      sig { override.returns({ data: T::Array[Privy::OAuthGrant] }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/privy/models/oauth_grant_revoke_response.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Privy
+  module Models
+    class OAuthGrantRevokeResponse < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Privy::OAuthGrantRevokeResponse, Privy::Internal::AnyHash)
+        end
+
+      # Whether the revocation was processed.
+      sig { returns(Privy::OAuthGrantRevokeResponse::Success::OrBoolean) }
+      attr_accessor :success
+
+      # Response from revoking an OAuth grant.
+      sig do
+        params(
+          success: Privy::OAuthGrantRevokeResponse::Success::OrBoolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether the revocation was processed.
+        success:
+      )
+      end
+
+      sig do
+        override.returns(
+          { success: Privy::OAuthGrantRevokeResponse::Success::OrBoolean }
+        )
+      end
+      def to_hash
+      end
+
+      # Whether the revocation was processed.
+      module Success
+        extend Privy::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(T::Boolean, Privy::OAuthGrantRevokeResponse::Success)
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(true, Privy::OAuthGrantRevokeResponse::Success::TaggedBoolean)
+
+        sig do
+          override.returns(
+            T::Array[Privy::OAuthGrantRevokeResponse::Success::TaggedBoolean]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/oauth_token_authorization_code_request_body.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Privy
+  module Models
+    class OAuthTokenAuthorizationCodeRequestBody < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::OAuthTokenAuthorizationCodeRequestBody,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      # The authorization code received from the authorization endpoint.
+      sig { returns(String) }
+      attr_accessor :code
+
+      sig do
+        returns(
+          Privy::OAuthTokenAuthorizationCodeRequestBody::GrantType::OrSymbol
+        )
+      end
+      attr_accessor :grant_type
+
+      # The client ID. Alternative to Basic auth header.
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_id
+
+      sig { params(client_id: String).void }
+      attr_writer :client_id
+
+      # The client secret. Alternative to Basic auth header.
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_secret
+
+      sig { params(client_secret: String).void }
+      attr_writer :client_secret
+
+      # The redirect URI used in the authorization request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :redirect_uri
+
+      sig { params(redirect_uri: String).void }
+      attr_writer :redirect_uri
+
+      # Request body for the authorization_code grant type.
+      sig do
+        params(
+          code: String,
+          grant_type:
+            Privy::OAuthTokenAuthorizationCodeRequestBody::GrantType::OrSymbol,
+          client_id: String,
+          client_secret: String,
+          redirect_uri: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The authorization code received from the authorization endpoint.
+        code:,
+        grant_type:,
+        # The client ID. Alternative to Basic auth header.
+        client_id: nil,
+        # The client secret. Alternative to Basic auth header.
+        client_secret: nil,
+        # The redirect URI used in the authorization request.
+        redirect_uri: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            code: String,
+            grant_type:
+              Privy::OAuthTokenAuthorizationCodeRequestBody::GrantType::OrSymbol,
+            client_id: String,
+            client_secret: String,
+            redirect_uri: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module GrantType
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Privy::OAuthTokenAuthorizationCodeRequestBody::GrantType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUTHORIZATION_CODE =
+          T.let(
+            :authorization_code,
+            Privy::OAuthTokenAuthorizationCodeRequestBody::GrantType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::OAuthTokenAuthorizationCodeRequestBody::GrantType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/oauth_token_device_code_pending_error.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Privy
+  module Models
+    class OAuthTokenDeviceCodePendingError < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::OAuthTokenDeviceCodePendingError,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      # The error code indicating why the token request failed.
+      sig { returns(Privy::OAuthTokenDeviceCodePendingError::Error::OrSymbol) }
+      attr_accessor :error
+
+      # Human-readable description of the error.
+      sig { returns(T.nilable(String)) }
+      attr_reader :error_description
+
+      sig { params(error_description: String).void }
+      attr_writer :error_description
+
+      # The minimum polling interval in seconds.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :interval
+
+      sig { params(interval: Float).void }
+      attr_writer :interval
+
+      # Error response returned while the device authorization is still pending (RFC
+      # 8628 Section 3.5).
+      sig do
+        params(
+          error: Privy::OAuthTokenDeviceCodePendingError::Error::OrSymbol,
+          error_description: String,
+          interval: Float
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The error code indicating why the token request failed.
+        error:,
+        # Human-readable description of the error.
+        error_description: nil,
+        # The minimum polling interval in seconds.
+        interval: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            error: Privy::OAuthTokenDeviceCodePendingError::Error::OrSymbol,
+            error_description: String,
+            interval: Float
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The error code indicating why the token request failed.
+      module Error
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Privy::OAuthTokenDeviceCodePendingError::Error)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUTHORIZATION_PENDING =
+          T.let(
+            :authorization_pending,
+            Privy::OAuthTokenDeviceCodePendingError::Error::TaggedSymbol
+          )
+        SLOW_DOWN =
+          T.let(
+            :slow_down,
+            Privy::OAuthTokenDeviceCodePendingError::Error::TaggedSymbol
+          )
+        ACCESS_DENIED =
+          T.let(
+            :access_denied,
+            Privy::OAuthTokenDeviceCodePendingError::Error::TaggedSymbol
+          )
+        EXPIRED_TOKEN =
+          T.let(
+            :expired_token,
+            Privy::OAuthTokenDeviceCodePendingError::Error::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::OAuthTokenDeviceCodePendingError::Error::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/oauth_token_device_code_request_body.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Privy
+  module Models
+    class OAuthTokenDeviceCodeRequestBody < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::OAuthTokenDeviceCodeRequestBody,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      # The device code received from the device authorization endpoint.
+      sig { returns(String) }
+      attr_accessor :device_code
+
+      sig do
+        returns(Privy::OAuthTokenDeviceCodeRequestBody::GrantType::OrSymbol)
+      end
+      attr_accessor :grant_type
+
+      # Request body for the urn:ietf:params:oauth:grant-type:device_code grant type
+      # (RFC 8628). Used by CLI clients to poll for authorization.
+      sig do
+        params(
+          device_code: String,
+          grant_type:
+            Privy::OAuthTokenDeviceCodeRequestBody::GrantType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The device code received from the device authorization endpoint.
+        device_code:,
+        grant_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            device_code: String,
+            grant_type:
+              Privy::OAuthTokenDeviceCodeRequestBody::GrantType::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module GrantType
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Privy::OAuthTokenDeviceCodeRequestBody::GrantType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        URN_IETF_PARAMS_OAUTH_GRANT_TYPE_DEVICE_CODE =
+          T.let(
+            :"urn:ietf:params:oauth:grant-type:device_code",
+            Privy::OAuthTokenDeviceCodeRequestBody::GrantType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::OAuthTokenDeviceCodeRequestBody::GrantType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/oauth_token_grant_type.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Privy
+  module Models
+    # The OAuth grant type for the token request.
+    module OAuthTokenGrantType
+      extend Privy::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Privy::OAuthTokenGrantType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      AUTHORIZATION_CODE =
+        T.let(:authorization_code, Privy::OAuthTokenGrantType::TaggedSymbol)
+      URN_IETF_PARAMS_OAUTH_GRANT_TYPE_DEVICE_CODE =
+        T.let(
+          :"urn:ietf:params:oauth:grant-type:device_code",
+          Privy::OAuthTokenGrantType::TaggedSymbol
+        )
+      REFRESH_TOKEN =
+        T.let(:refresh_token, Privy::OAuthTokenGrantType::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Privy::OAuthTokenGrantType::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/privy/models/oauth_token_refresh_token_request_body.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Privy
+  module Models
+    class OAuthTokenRefreshTokenRequestBody < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Privy::OAuthTokenRefreshTokenRequestBody,
+            Privy::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(Privy::OAuthTokenRefreshTokenRequestBody::GrantType::OrSymbol)
+      end
+      attr_accessor :grant_type
+
+      # The refresh token to exchange for a new access token.
+      sig { returns(String) }
+      attr_accessor :refresh_token
+
+      # Request body for the refresh_token grant type. Rotates the refresh token and
+      # issues a new access token.
+      sig do
+        params(
+          grant_type:
+            Privy::OAuthTokenRefreshTokenRequestBody::GrantType::OrSymbol,
+          refresh_token: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        grant_type:,
+        # The refresh token to exchange for a new access token.
+        refresh_token:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            grant_type:
+              Privy::OAuthTokenRefreshTokenRequestBody::GrantType::OrSymbol,
+            refresh_token: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module GrantType
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Privy::OAuthTokenRefreshTokenRequestBody::GrantType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        REFRESH_TOKEN =
+          T.let(
+            :refresh_token,
+            Privy::OAuthTokenRefreshTokenRequestBody::GrantType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Privy::OAuthTokenRefreshTokenRequestBody::GrantType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/oauth_token_request_body.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Privy
+  module Models
+    # Request body for the OAuth token endpoint, discriminated by grant_type.
+    module OAuthTokenRequestBody
+      extend Privy::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Privy::OAuthTokenAuthorizationCodeRequestBody,
+            Privy::OAuthTokenDeviceCodeRequestBody,
+            Privy::OAuthTokenRefreshTokenRequestBody
+          )
+        end
+
+      sig { override.returns(T::Array[Privy::OAuthTokenRequestBody::Variants]) }
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/privy/models/oauth_token_success_response.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Privy
+  module Models
+    class OAuthTokenSuccessResponse < Privy::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Privy::OAuthTokenSuccessResponse, Privy::Internal::AnyHash)
+        end
+
+      # The issued access token.
+      sig { returns(String) }
+      attr_accessor :access_token
+
+      # The type of token issued.
+      sig { returns(Privy::OAuthTokenSuccessResponse::TokenType::OrSymbol) }
+      attr_accessor :token_type
+
+      # The lifetime in seconds of the access token.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :expires_in
+
+      sig { params(expires_in: Float).void }
+      attr_writer :expires_in
+
+      # A refresh token for obtaining new access tokens. Issued for device_code and
+      # refresh_token grants.
+      sig { returns(T.nilable(String)) }
+      attr_reader :refresh_token
+
+      sig { params(refresh_token: String).void }
+      attr_writer :refresh_token
+
+      # Successful token response per RFC 6749 Section 5.1.
+      sig do
+        params(
+          access_token: String,
+          token_type: Privy::OAuthTokenSuccessResponse::TokenType::OrSymbol,
+          expires_in: Float,
+          refresh_token: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The issued access token.
+        access_token:,
+        # The type of token issued.
+        token_type:,
+        # The lifetime in seconds of the access token.
+        expires_in: nil,
+        # A refresh token for obtaining new access tokens. Issued for device_code and
+        # refresh_token grants.
+        refresh_token: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            access_token: String,
+            token_type: Privy::OAuthTokenSuccessResponse::TokenType::OrSymbol,
+            expires_in: Float,
+            refresh_token: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The type of token issued.
+      module TokenType
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Privy::OAuthTokenSuccessResponse::TokenType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BEARER =
+          T.let(
+            :Bearer,
+            Privy::OAuthTokenSuccessResponse::TokenType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Privy::OAuthTokenSuccessResponse::TokenType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end