finch-api 0.1.0.pre.alpha.27 → 0.1.0.pre.alpha.28

data/lib/finch_api/resources/access_tokens.rb

@@ -5,12 +5,16 @@ module FinchAPI
     class AccessTokens
       # Exchange the authorization code for an access token
       #
-      # @overload create(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {})
+      # @overload create(client_id:, client_secret:, code:, redirect_uri: nil, request_options: {})
+      #
+      # @param client_id [String] The client ID for your application
+      #
+      # @param client_secret [String] The client secret for your application
+      #
+      # @param code [String] The authorization code received from the authorization server
+      #
+      # @param redirect_uri [String] The redirect URI used in the authorization request (optional)
       #
-      # @param code [String]
-      # @param client_id [String]
-      # @param client_secret [String]
-      # @param redirect_uri [String]
       # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [FinchAPI::Models::CreateAccessTokenResponse]

data/lib/finch_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  VERSION = "0.1.0.pre.alpha.27"
+  VERSION = "0.1.0.pre.alpha.28"
 end

data/rbi/finch_api/models/access_token_create_params.rbi

@@ -11,21 +11,19 @@ module FinchAPI
           T.any(FinchAPI::AccessTokenCreateParams, FinchAPI::Internal::AnyHash)
         end
 
+      # The client ID for your application
       sig { returns(String) }
-      attr_accessor :code
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :client_id
+      attr_accessor :client_id
 
-      sig { params(client_id: String).void }
-      attr_writer :client_id
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :client_secret
+      # The client secret for your application
+      sig { returns(String) }
+      attr_accessor :client_secret
 
-      sig { params(client_secret: String).void }
-      attr_writer :client_secret
+      # The authorization code received from the authorization server
+      sig { returns(String) }
+      attr_accessor :code
 
+      # The redirect URI used in the authorization request (optional)
       sig { returns(T.nilable(String)) }
       attr_reader :redirect_uri
 
@@ -34,17 +32,21 @@ module FinchAPI
 
       sig do
         params(
-          code: String,
           client_id: String,
           client_secret: String,
+          code: String,
           redirect_uri: String,
           request_options: FinchAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # The client ID for your application
+        client_id:,
+        # The client secret for your application
+        client_secret:,
+        # The authorization code received from the authorization server
         code:,
-        client_id: nil,
-        client_secret: nil,
+        # The redirect URI used in the authorization request (optional)
         redirect_uri: nil,
         request_options: {}
       )
@@ -53,9 +55,9 @@ module FinchAPI
       sig do
         override.returns(
           {
-            code: String,
             client_id: String,
             client_secret: String,
+            code: String,
             redirect_uri: String,
             request_options: FinchAPI::RequestOptions
           }

data/rbi/finch_api/models/create_access_token_response.rbi

@@ -11,27 +11,17 @@ module FinchAPI
           )
         end
 
-      # The access token for the connection.
+      # The access token for the connection
       sig { returns(String) }
       attr_accessor :access_token
 
-      # [DEPRECATED] Use `connection_id` to identify the connection instead of this
-      # account ID.
-      sig { returns(String) }
-      attr_accessor :account_id
-
       # The type of application associated with a token.
       sig do
         returns(FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol)
       end
       attr_accessor :client_type
 
-      # [DEPRECATED] Use `connection_id` to identify the connection instead of this
-      # company ID.
-      sig { returns(String) }
-      attr_accessor :company_id
-
-      # The Finch UUID of the connection associated with the `access_token`.
+      # The Finch UUID of the connection associated with the `access_token`
       sig { returns(String) }
       attr_accessor :connection_id
 
@@ -46,69 +36,82 @@ module FinchAPI
       end
       attr_accessor :connection_type
 
-      # An array of the authorized products associated with the `access_token`.
+      # An array of the authorized products associated with the `access_token`
       sig { returns(T::Array[String]) }
       attr_accessor :products
 
-      # The ID of the provider associated with the `access_token`.
+      # The ID of the provider associated with the `access_token`
       sig { returns(String) }
       attr_accessor :provider_id
 
-      # The ID of your customer you provided to Finch when a connect session was created
-      # for this connection.
+      # The RFC 8693 token type (Finch uses `bearer` tokens)
+      sig { returns(String) }
+      attr_accessor :token_type
+
+      # [DEPRECATED] Use `connection_id` to identify the connection instead of this
+      # account ID
       sig { returns(T.nilable(String)) }
-      attr_accessor :customer_id
+      attr_reader :account_id
 
-      # The RFC 8693 token type (Finch uses `bearer` tokens)
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # [DEPRECATED] Use `connection_id` to identify the connection instead of this
+      # company ID
       sig { returns(T.nilable(String)) }
-      attr_reader :token_type
+      attr_reader :company_id
+
+      sig { params(company_id: String).void }
+      attr_writer :company_id
 
-      sig { params(token_type: String).void }
-      attr_writer :token_type
+      # The ID of your customer you provided to Finch when a connect session was created
+      # for this connection
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_id
 
       sig do
         params(
           access_token: String,
-          account_id: String,
           client_type:
             FinchAPI::CreateAccessTokenResponse::ClientType::OrSymbol,
-          company_id: String,
           connection_id: String,
           connection_type:
             FinchAPI::CreateAccessTokenResponse::ConnectionType::OrSymbol,
           products: T::Array[String],
           provider_id: String,
-          customer_id: T.nilable(String),
-          token_type: String
+          token_type: String,
+          account_id: String,
+          company_id: String,
+          customer_id: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
-        # The access token for the connection.
+        # The access token for the connection
         access_token:,
-        # [DEPRECATED] Use `connection_id` to identify the connection instead of this
-        # account ID.
-        account_id:,
         # The type of application associated with a token.
         client_type:,
-        # [DEPRECATED] Use `connection_id` to identify the connection instead of this
-        # company ID.
-        company_id:,
-        # The Finch UUID of the connection associated with the `access_token`.
+        # The Finch UUID of the connection associated with the `access_token`
         connection_id:,
         # The type of the connection associated with the token.
         #
         # - `provider` - connection to an external provider
         # - `finch` - finch-generated data.
         connection_type:,
-        # An array of the authorized products associated with the `access_token`.
+        # An array of the authorized products associated with the `access_token`
         products:,
-        # The ID of the provider associated with the `access_token`.
+        # The ID of the provider associated with the `access_token`
         provider_id:,
-        # The ID of your customer you provided to Finch when a connect session was created
-        # for this connection.
-        customer_id: nil,
         # The RFC 8693 token type (Finch uses `bearer` tokens)
-        token_type: nil
+        token_type:,
+        # [DEPRECATED] Use `connection_id` to identify the connection instead of this
+        # account ID
+        account_id: nil,
+        # [DEPRECATED] Use `connection_id` to identify the connection instead of this
+        # company ID
+        company_id: nil,
+        # The ID of your customer you provided to Finch when a connect session was created
+        # for this connection
+        customer_id: nil
       )
       end
 
@@ -116,17 +119,17 @@ module FinchAPI
         override.returns(
           {
             access_token: String,
-            account_id: String,
             client_type:
               FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol,
-            company_id: String,
             connection_id: String,
             connection_type:
               FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol,
             products: T::Array[String],
             provider_id: String,
-            customer_id: T.nilable(String),
-            token_type: String
+            token_type: String,
+            account_id: String,
+            company_id: String,
+            customer_id: T.nilable(String)
           }
         )
       end
@@ -143,14 +146,14 @@ module FinchAPI
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PRODUCTION =
+        DEVELOPMENT =
           T.let(
-            :production,
+            :development,
             FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol
           )
-        DEVELOPMENT =
+        PRODUCTION =
           T.let(
-            :development,
+            :production,
             FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol
           )
         SANDBOX =
@@ -183,14 +186,14 @@ module FinchAPI
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PROVIDER =
+        FINCH =
           T.let(
-            :provider,
+            :finch,
             FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol
           )
-        FINCH =
+        PROVIDER =
           T.let(
-            :finch,
+            :provider,
             FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol
           )