finch-api 0.1.0.pre.alpha.39 → 0.1.0.pre.alpha.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -0
  3. data/README.md +10 -1
  4. data/lib/finch_api/models/sandbox/connection_create_response.rb +9 -1
  5. data/lib/finch_api/models/sandbox/connections/account_create_response.rb +9 -1
  6. data/lib/finch_api/models/sandbox/connections/account_update_response.rb +17 -9
  7. data/lib/finch_api/version.rb +1 -1
  8. data/rbi/finch_api/models/sandbox/connection_create_response.rbi +8 -0
  9. data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi +8 -0
  10. data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi +19 -14
  11. data/sig/finch_api/models/sandbox/connection_create_response.rbs +5 -0
  12. data/sig/finch_api/models/sandbox/connections/account_create_response.rbs +5 -0
  13. data/sig/finch_api/models/sandbox/connections/account_update_response.rbs +13 -10
  14. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0111f0539076aa0b796deb95cd2735264cde7205b9128ef2ab38c14451bab976
4
- data.tar.gz: 38b82f3652758882b70bc01aef5f370d3c0dbbdd0f1b60e8ad3b47a0ab7568f0
3
+ metadata.gz: 314161384d71b7c4f61f36dde0af6cf63e97c43cb141ea124e251d2914cf041b
4
+ data.tar.gz: e0762fe9916202301a471b652e611a628a41002fe31f40789d70ce662c4a6152
5
5
  SHA512:
6
- metadata.gz: 30086bac7adbb05f5cddb9c0d8ed2c64ef68845ce83748e176fbff16c31c5d7e27df60682cfeeb3cbebb556f61206c60581ac15cdb1cd7068325ba707365e47d
7
- data.tar.gz: 758c7e5addb846651c1ee651b64f38dac9ca141714dc61f26bd710e06ba119fb83bd415e2e4ffa94d4337ba8d9f61c633b8f5aa3935ae14941bbb00d0eb6822b
6
+ metadata.gz: e3944b694e4288ff64e7f28cf7ce0ad411edf547cca87ac4665cac03e9f75138adc9162ab7425c336aaead70fe22516bf48040b006dce3cf6a1e4b6470c82e10
7
+ data.tar.gz: 50b5484f1ad97eed848afff3115d25de3743a94a35981658dded01d0b8325743e5c6b747bedc6a71183de87d78c2b4de30e1daf9e69800ebc80d4fece8f57213
data/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.0-alpha.40 (2026-01-05)
4
+
5
+ Full Changelog: [v0.1.0-alpha.39...v0.1.0-alpha.40](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.39...v0.1.0-alpha.40)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([82c2483](https://github.com/Finch-API/finch-api-ruby/commit/82c2483e09e0facae50bc1fc3601b922ae86a5a5))
10
+
11
+
12
+ ### Chores
13
+
14
+ * **internal:** codegen related update ([74a742a](https://github.com/Finch-API/finch-api-ruby/commit/74a742a5f1c7673a9f8fb06b5daaac5daf204fd5))
15
+
16
+
17
+ ### Documentation
18
+
19
+ * prominently feature MCP server setup in root SDK readmes ([6d995c9](https://github.com/Finch-API/finch-api-ruby/commit/6d995c9789915687a71b11c33b1b5b8ccc9ffa48))
20
+
3
21
  ## 0.1.0-alpha.39 (2025-12-19)
4
22
 
5
23
  Full Changelog: [v0.1.0-alpha.38...v0.1.0-alpha.39](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.38...v0.1.0-alpha.39)
data/README.md CHANGED
@@ -4,6 +4,15 @@ The Finch Ruby library provides convenient access to the Finch REST API from any
4
4
 
5
5
  It is generated with [Stainless](https://www.stainless.com/).
6
6
 
7
+ ## MCP Server
8
+
9
+ Use the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
10
+
11
+ [![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl19)
12
+ [![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%7D)
13
+
14
+ > Note: You may need to set environment variables in your MCP client.
15
+
7
16
  ## Documentation
8
17
 
9
18
  Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api).
@@ -17,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
17
26
  <!-- x-release-please-start-version -->
18
27
 
19
28
  ```ruby
20
- gem "finch-api", "~> 0.1.0.pre.alpha.39"
29
+ gem "finch-api", "~> 0.1.0.pre.alpha.40"
21
30
  ```
22
31
 
23
32
  <!-- x-release-please-end -->
data/lib/finch_api/models/sandbox/connection_create_response.rb CHANGED
@@ -38,6 +38,12 @@ module FinchAPI
38
38
  # @return [String]
39
39
  required :connection_id, String
40
40
 
41
+ # @!attribute entity_id
42
+ # The ID of the entity for this connection
43
+ #
44
+ # @return [String]
45
+ required :entity_id, String
46
+
41
47
  # @!attribute products
42
48
  #
43
49
  # @return [Array<String>]
@@ -54,7 +60,7 @@ module FinchAPI
54
60
  # @return [String, nil]
55
61
  optional :token_type, String
56
62
 
57
- # @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, products:, provider_id:, token_type: nil)
63
+ # @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:, token_type: nil)
58
64
  # @param access_token [String]
59
65
  #
60
66
  # @param account_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
@@ -65,6 +71,8 @@ module FinchAPI
65
71
  #
66
72
  # @param connection_id [String] The ID of the new connection
67
73
  #
74
+ # @param entity_id [String] The ID of the entity for this connection
75
+ #
68
76
  # @param products [Array<String>]
69
77
  #
70
78
  # @param provider_id [String] The ID of the provider associated with the `access_token`.
data/lib/finch_api/models/sandbox/connections/account_create_response.rb CHANGED
@@ -39,6 +39,12 @@ module FinchAPI
39
39
  # @return [String]
40
40
  required :connection_id, String
41
41
 
42
+ # @!attribute entity_id
43
+ # The ID of the entity for this connection
44
+ #
45
+ # @return [String]
46
+ required :entity_id, String
47
+
42
48
  # @!attribute products
43
49
  #
44
50
  # @return [Array<String>]
@@ -50,7 +56,7 @@ module FinchAPI
50
56
  # @return [String]
51
57
  required :provider_id, String
52
58
 
53
- # @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, products:, provider_id:)
59
+ # @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:)
54
60
  # @param access_token [String]
55
61
  #
56
62
  # @param account_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
@@ -61,6 +67,8 @@ module FinchAPI
61
67
  #
62
68
  # @param connection_id [String] The ID of the new connection
63
69
  #
70
+ # @param entity_id [String] The ID of the entity for this connection
71
+ #
64
72
  # @param products [Array<String>]
65
73
  #
66
74
  # @param provider_id [String] The ID of the provider associated with the `access_token`
data/lib/finch_api/models/sandbox/connections/account_update_response.rb CHANGED
@@ -28,6 +28,18 @@ module FinchAPI
28
28
  # @return [String]
29
29
  required :company_id, String
30
30
 
31
+ # @!attribute connection_id
32
+ # The ID of the new connection
33
+ #
34
+ # @return [String]
35
+ required :connection_id, String
36
+
37
+ # @!attribute entity_id
38
+ # The ID of the entity whose status was updated
39
+ #
40
+ # @return [String]
41
+ required :entity_id, String
42
+
31
43
  # @!attribute products
32
44
  #
33
45
  # @return [Array<String>]
@@ -39,24 +51,20 @@ module FinchAPI
39
51
  # @return [String]
40
52
  required :provider_id, String
41
53
 
42
- # @!attribute connection_id
43
- # The ID of the new connection
44
- #
45
- # @return [String, nil]
46
- optional :connection_id, String
47
-
48
- # @!method initialize(account_id:, authentication_type:, company_id:, products:, provider_id:, connection_id: nil)
54
+ # @!method initialize(account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:)
49
55
  # @param account_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
50
56
  #
51
57
  # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType]
52
58
  #
53
59
  # @param company_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
54
60
  #
61
+ # @param connection_id [String] The ID of the new connection
62
+ #
63
+ # @param entity_id [String] The ID of the entity whose status was updated
64
+ #
55
65
  # @param products [Array<String>]
56
66
  #
57
67
  # @param provider_id [String] The ID of the provider associated with the `access_token`
58
- #
59
- # @param connection_id [String] The ID of the new connection
60
68
 
61
69
  # @see FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse#authentication_type
62
70
  module AuthenticationType
data/lib/finch_api/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module FinchAPI
4
- VERSION = "0.1.0.pre.alpha.39"
4
+ VERSION = "0.1.0.pre.alpha.40"
5
5
  end
data/rbi/finch_api/models/sandbox/connection_create_response.rbi CHANGED
@@ -34,6 +34,10 @@ module FinchAPI
34
34
  sig { returns(String) }
35
35
  attr_accessor :connection_id
36
36
 
37
+ # The ID of the entity for this connection
38
+ sig { returns(String) }
39
+ attr_accessor :entity_id
40
+
37
41
  sig { returns(T::Array[String]) }
38
42
  attr_accessor :products
39
43
 
@@ -55,6 +59,7 @@ module FinchAPI
55
59
  FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::OrSymbol,
56
60
  company_id: String,
57
61
  connection_id: String,
62
+ entity_id: String,
58
63
  products: T::Array[String],
59
64
  provider_id: String,
60
65
  token_type: String
@@ -69,6 +74,8 @@ module FinchAPI
69
74
  company_id:,
70
75
  # The ID of the new connection
71
76
  connection_id:,
77
+ # The ID of the entity for this connection
78
+ entity_id:,
72
79
  products:,
73
80
  # The ID of the provider associated with the `access_token`.
74
81
  provider_id:,
@@ -85,6 +92,7 @@ module FinchAPI
85
92
  FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol,
86
93
  company_id: String,
87
94
  connection_id: String,
95
+ entity_id: String,
88
96
  products: T::Array[String],
89
97
  provider_id: String,
90
98
  token_type: String
data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi CHANGED
@@ -35,6 +35,10 @@ module FinchAPI
35
35
  sig { returns(String) }
36
36
  attr_accessor :connection_id
37
37
 
38
+ # The ID of the entity for this connection
39
+ sig { returns(String) }
40
+ attr_accessor :entity_id
41
+
38
42
  sig { returns(T::Array[String]) }
39
43
  attr_accessor :products
40
44
 
@@ -50,6 +54,7 @@ module FinchAPI
50
54
  FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::OrSymbol,
51
55
  company_id: String,
52
56
  connection_id: String,
57
+ entity_id: String,
53
58
  products: T::Array[String],
54
59
  provider_id: String
55
60
  ).returns(T.attached_class)
@@ -63,6 +68,8 @@ module FinchAPI
63
68
  company_id:,
64
69
  # The ID of the new connection
65
70
  connection_id:,
71
+ # The ID of the entity for this connection
72
+ entity_id:,
66
73
  products:,
67
74
  # The ID of the provider associated with the `access_token`
68
75
  provider_id:
@@ -78,6 +85,7 @@ module FinchAPI
78
85
  FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol,
79
86
  company_id: String,
80
87
  connection_id: String,
88
+ entity_id: String,
81
89
  products: T::Array[String],
82
90
  provider_id: String
83
91
  }
data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi CHANGED
@@ -28,6 +28,14 @@ module FinchAPI
28
28
  sig { returns(String) }
29
29
  attr_accessor :company_id
30
30
 
31
+ # The ID of the new connection
32
+ sig { returns(String) }
33
+ attr_accessor :connection_id
34
+
35
+ # The ID of the entity whose status was updated
36
+ sig { returns(String) }
37
+ attr_accessor :entity_id
38
+
31
39
  sig { returns(T::Array[String]) }
32
40
  attr_accessor :products
33
41
 
@@ -35,22 +43,16 @@ module FinchAPI
35
43
  sig { returns(String) }
36
44
  attr_accessor :provider_id
37
45
 
38
- # The ID of the new connection
39
- sig { returns(T.nilable(String)) }
40
- attr_reader :connection_id
41
-
42
- sig { params(connection_id: String).void }
43
- attr_writer :connection_id
44
-
45
46
  sig do
46
47
  params(
47
48
  account_id: String,
48
49
  authentication_type:
49
50
  FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::OrSymbol,
50
51
  company_id: String,
52
+ connection_id: String,
53
+ entity_id: String,
51
54
  products: T::Array[String],
52
- provider_id: String,
53
- connection_id: String
55
+ provider_id: String
54
56
  ).returns(T.attached_class)
55
57
  end
56
58
  def self.new(
@@ -59,11 +61,13 @@ module FinchAPI
59
61
  authentication_type:,
60
62
  # [DEPRECATED] Use `connection_id` to associate a connection with an access token
61
63
  company_id:,
64
+ # The ID of the new connection
65
+ connection_id:,
66
+ # The ID of the entity whose status was updated
67
+ entity_id:,
62
68
  products:,
63
69
  # The ID of the provider associated with the `access_token`
64
- provider_id:,
65
- # The ID of the new connection
66
- connection_id: nil
70
+ provider_id:
67
71
  )
68
72
  end
69
73
 
@@ -74,9 +78,10 @@ module FinchAPI
74
78
  authentication_type:
75
79
  FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol,
76
80
  company_id: String,
81
+ connection_id: String,
82
+ entity_id: String,
77
83
  products: T::Array[String],
78
- provider_id: String,
79
- connection_id: String
84
+ provider_id: String
80
85
  }
81
86
  )
82
87
  end
data/sig/finch_api/models/sandbox/connection_create_response.rbs CHANGED
@@ -8,6 +8,7 @@ module FinchAPI
8
8
  authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
9
9
  company_id: String,
10
10
  connection_id: String,
11
+ entity_id: String,
11
12
  products: ::Array[String],
12
13
  provider_id: String,
13
14
  token_type: String
@@ -24,6 +25,8 @@ module FinchAPI
24
25
 
25
26
  attr_accessor connection_id: String
26
27
 
28
+ attr_accessor entity_id: String
29
+
27
30
  attr_accessor products: ::Array[String]
28
31
 
29
32
  attr_accessor provider_id: String
@@ -38,6 +41,7 @@ module FinchAPI
38
41
  authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
39
42
  company_id: String,
40
43
  connection_id: String,
44
+ entity_id: String,
41
45
  products: ::Array[String],
42
46
  provider_id: String,
43
47
  ?token_type: String
@@ -49,6 +53,7 @@ module FinchAPI
49
53
  authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
50
54
  company_id: String,
51
55
  connection_id: String,
56
+ entity_id: String,
52
57
  products: ::Array[String],
53
58
  provider_id: String,
54
59
  token_type: String
data/sig/finch_api/models/sandbox/connections/account_create_response.rbs CHANGED
@@ -9,6 +9,7 @@ module FinchAPI
9
9
  authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type,
10
10
  company_id: String,
11
11
  connection_id: String,
12
+ entity_id: String,
12
13
  products: ::Array[String],
13
14
  provider_id: String
14
15
  }
@@ -24,6 +25,8 @@ module FinchAPI
24
25
 
25
26
  attr_accessor connection_id: String
26
27
 
28
+ attr_accessor entity_id: String
29
+
27
30
  attr_accessor products: ::Array[String]
28
31
 
29
32
  attr_accessor provider_id: String
@@ -34,6 +37,7 @@ module FinchAPI
34
37
  authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type,
35
38
  company_id: String,
36
39
  connection_id: String,
40
+ entity_id: String,
37
41
  products: ::Array[String],
38
42
  provider_id: String
39
43
  ) -> void
@@ -44,6 +48,7 @@ module FinchAPI
44
48
  authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type,
45
49
  company_id: String,
46
50
  connection_id: String,
51
+ entity_id: String,
47
52
  products: ::Array[String],
48
53
  provider_id: String
49
54
  }
data/sig/finch_api/models/sandbox/connections/account_update_response.rbs CHANGED
@@ -7,9 +7,10 @@ module FinchAPI
7
7
  account_id: String,
8
8
  authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type,
9
9
  company_id: String,
10
+ connection_id: String,
11
+ entity_id: String,
10
12
  products: ::Array[String],
11
- provider_id: String,
12
- connection_id: String
13
+ provider_id: String
13
14
  }
14
15
 
15
16
  class AccountUpdateResponse < FinchAPI::Internal::Type::BaseModel
@@ -19,30 +20,32 @@ module FinchAPI
19
20
 
20
21
  attr_accessor company_id: String
21
22
 
22
- attr_accessor products: ::Array[String]
23
+ attr_accessor connection_id: String
23
24
 
24
- attr_accessor provider_id: String
25
+ attr_accessor entity_id: String
25
26
 
26
- attr_reader connection_id: String?
27
+ attr_accessor products: ::Array[String]
27
28
 
28
- def connection_id=: (String) -> String
29
+ attr_accessor provider_id: String
29
30
 
30
31
  def initialize: (
31
32
  account_id: String,
32
33
  authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type,
33
34
  company_id: String,
35
+ connection_id: String,
36
+ entity_id: String,
34
37
  products: ::Array[String],
35
- provider_id: String,
36
- ?connection_id: String
38
+ provider_id: String
37
39
  ) -> void
38
40
 
39
41
  def to_hash: -> {
40
42
  account_id: String,
41
43
  authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type,
42
44
  company_id: String,
45
+ connection_id: String,
46
+ entity_id: String,
43
47
  products: ::Array[String],
44
- provider_id: String,
45
- connection_id: String
48
+ provider_id: String
46
49
  }
47
50
 
48
51
  type authentication_type =
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: finch-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0.pre.alpha.39
4
+ version: 0.1.0.pre.alpha.40
5
5
  platform: ruby
6
6
  authors:
7
7
  - Finch
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-12-30 00:00:00.000000000 Z
11
+ date: 2026-01-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool