release: 0.1.0-alpha.28 (#159)

* feat(api): api update

* release: 0.1.0-alpha.28

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.27"
+  ".": "0.1.0-alpha.28"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-e8b684dbd61d1724b5e516a573a952bb6906d63840e27ebda7731a2f71061aff.yml
-openapi_spec_hash: 8baff9577d4e721d0494ff315da267ca
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-6d0c6a1feba5ccb895a6779cd98c2a0ae87d6394f5e98a9da51f17258c4eb297.yml
+openapi_spec_hash: ac3be0c8a992103e5f467fe1bcb20a81
 config_hash: 5146b12344dae76238940989dac1e8a0

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.28 (2025-08-20)
+
+Full Changelog: [v0.1.0-alpha.27...v0.1.0-alpha.28](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.27...v0.1.0-alpha.28)
+
+### Features
+
+* **api:** api update ([e615899](https://github.com/Finch-API/finch-api-ruby/commit/e615899d0e9c1243db7fa677f08411ef4c291bbd))
+
 ## 0.1.0-alpha.27 (2025-08-19)
 
 Full Changelog: [v0.1.0-alpha.26...v0.1.0-alpha.27](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.26...v0.1.0-alpha.27)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    finch-api (0.1.0.pre.alpha.27)
+    finch-api (0.1.0.pre.alpha.28)
       connection_pool
 
 GEM

README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "finch-api", "~> 0.1.0.pre.alpha.27"
+gem "finch-api", "~> 0.1.0.pre.alpha.28"
 ```
 
 <!-- x-release-please-end -->

lib/finch_api/models/access_token_create_params.rb

@@ -7,31 +7,39 @@ class AccessTokenCreateParams < FinchAPI::Internal::Type::BaseModel
       extend FinchAPI::Internal::Type::RequestParameters::Converter
       include FinchAPI::Internal::Type::RequestParameters
 
-      # @!attribute code
+      # @!attribute client_id
+      #   The client ID for your application
       #
       #   @return [String]
-      required :code, String
+      required :client_id, String
 
-      # @!attribute client_id
+      # @!attribute client_secret
+      #   The client secret for your application
       #
-      #   @return [String, nil]
-      optional :client_id, String
+      #   @return [String]
+      required :client_secret, String
 
-      # @!attribute client_secret
+      # @!attribute code
+      #   The authorization code received from the authorization server
       #
-      #   @return [String, nil]
-      optional :client_secret, String
+      #   @return [String]
+      required :code, String
 
       # @!attribute redirect_uri
+      #   The redirect URI used in the authorization request (optional)
       #
       #   @return [String, nil]
       optional :redirect_uri, String
 
-      # @!method initialize(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {})
-      #   @param code [String]
-      #   @param client_id [String]
-      #   @param client_secret [String]
-      #   @param redirect_uri [String]
+      # @!method initialize(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 request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/finch_api/models/create_access_token_response.rb

@@ -5,37 +5,19 @@ module Models
     # @see FinchAPI::Resources::AccessTokens#create
     class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
       # @!attribute access_token
-      #   The access token for the connection.
+      #   The access token for the connection
       #
       #   @return [String]
       required :access_token, String
 
-      # @!attribute account_id
-      #   @deprecated
-      #
-      #   [DEPRECATED] Use `connection_id` to identify the connection instead of this
-      #   account ID.
-      #
-      #   @return [String]
-      required :account_id, String
-
       # @!attribute client_type
       #   The type of application associated with a token.
       #
       #   @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType]
       required :client_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ClientType }
 
-      # @!attribute company_id
-      #   @deprecated
-      #
-      #   [DEPRECATED] Use `connection_id` to identify the connection instead of this
-      #   company ID.
-      #
-      #   @return [String]
-      required :company_id, String
-
       # @!attribute connection_id
-      #   The Finch UUID of the connection associated with the `access_token`.
+      #   The Finch UUID of the connection associated with the `access_token`
       #
       #   @return [String]
       required :connection_id, String
@@ -50,62 +32,80 @@ class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
       required :connection_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ConnectionType }
 
       # @!attribute products
-      #   An array of the authorized products associated with the `access_token`.
+      #   An array of the authorized products associated with the `access_token`
       #
       #   @return [Array<String>]
       required :products, FinchAPI::Internal::Type::ArrayOf[String]
 
       # @!attribute provider_id
-      #   The ID of the provider associated with the `access_token`.
+      #   The ID of the provider associated with the `access_token`
       #
       #   @return [String]
       required :provider_id, String
 
-      # @!attribute customer_id
-      #   The ID of your customer you provided to Finch when a connect session was created
-      #   for this connection.
+      # @!attribute token_type
+      #   The RFC 8693 token type (Finch uses `bearer` tokens)
+      #
+      #   @return [String]
+      required :token_type, String
+
+      # @!attribute account_id
+      #   @deprecated
+      #
+      #   [DEPRECATED] Use `connection_id` to identify the connection instead of this
+      #   account ID
       #
       #   @return [String, nil]
-      optional :customer_id, String, nil?: true
+      optional :account_id, String
 
-      # @!attribute token_type
-      #   The RFC 8693 token type (Finch uses `bearer` tokens)
+      # @!attribute company_id
+      #   @deprecated
+      #
+      #   [DEPRECATED] Use `connection_id` to identify the connection instead of this
+      #   company ID
+      #
+      #   @return [String, nil]
+      optional :company_id, String
+
+      # @!attribute customer_id
+      #   The ID of your customer you provided to Finch when a connect session was created
+      #   for this connection
       #
       #   @return [String, nil]
-      optional :token_type, String
+      optional :customer_id, String, nil?: true
 
-      # @!method initialize(access_token:, account_id:, client_type:, company_id:, connection_id:, connection_type:, products:, provider_id:, customer_id: nil, token_type: nil)
+      # @!method initialize(access_token:, client_type:, connection_id:, connection_type:, products:, provider_id:, token_type:, account_id: nil, company_id: nil, customer_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {FinchAPI::Models::CreateAccessTokenResponse} for more details.
       #
-      #   @param access_token [String] The access token for the connection.
-      #
-      #   @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
+      #   @param access_token [String] The access token for the connection
       #
       #   @param client_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType] The type of application associated with a token.
       #
-      #   @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
-      #
-      #   @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
+      #   @param connection_id [String] The Finch UUID of the connection associated with the `access_token`
       #
       #   @param connection_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token.
       #
-      #   @param products [Array<String>] An array of the authorized products associated with the `access_token`.
-      #
-      #   @param provider_id [String] The ID of the provider associated with the `access_token`.
+      #   @param products [Array<String>] An array of the authorized products associated with the `access_token`
       #
-      #   @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created
+      #   @param provider_id [String] The ID of the provider associated with the `access_token`
       #
       #   @param token_type [String] The RFC 8693 token type (Finch uses `bearer` tokens)
+      #
+      #   @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
+      #
+      #   @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
+      #
+      #   @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created
 
       # The type of application associated with a token.
       #
       # @see FinchAPI::Models::CreateAccessTokenResponse#client_type
       module ClientType
         extend FinchAPI::Internal::Type::Enum
 
-        PRODUCTION = :production
         DEVELOPMENT = :development
+        PRODUCTION = :production
         SANDBOX = :sandbox
 
         # @!method self.values
@@ -121,8 +121,8 @@ module ClientType
       module ConnectionType
         extend FinchAPI::Internal::Type::Enum
 
-        PROVIDER = :provider
         FINCH = :finch
+        PROVIDER = :provider
 
         # @!method self.values
         #   @return [Array<Symbol>]