finch-api 0.1.0.pre.alpha.27 → 0.1.0.pre.alpha.29
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +21 -0
- data/README.md +1 -1
- data/lib/finch_api/models/access_token_create_params.rb +21 -13
- data/lib/finch_api/models/create_access_token_response.rb +42 -42
- data/lib/finch_api/models/introspection.rb +205 -133
- data/lib/finch_api/resources/access_tokens.rb +9 -5
- data/lib/finch_api/version.rb +1 -1
- data/rbi/finch_api/models/access_token_create_params.rbi +17 -15
- data/rbi/finch_api/models/create_access_token_response.rbi +54 -51
- data/rbi/finch_api/models/introspection.rbi +343 -223
- data/rbi/finch_api/resources/access_tokens.rbi +7 -3
- data/sig/finch_api/models/access_token_create_params.rbs +7 -11
- data/sig/finch_api/models/create_access_token_response.rbs +25 -23
- data/sig/finch_api/models/introspection.rbs +160 -111
- data/sig/finch_api/resources/access_tokens.rbs +2 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1c13a4af631ebb4f8780ba93cd0678bae144e736eada662e057b3d3c05bdc4d2
|
4
|
+
data.tar.gz: 357f7b8c96ddc548b5337a47dae1bf906d97773a096753752109b054d881a612
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0fb55a12f59529e6c8ee96d440131da38c3d0f1e814a8213a5fb8af64ee4f293fd12e107658b3e24b92dda68d9a7ae386b4f6e43ffe8667cceb292fb70ae8152
|
7
|
+
data.tar.gz: e9a162190490a8d62cea6a1250bd3c775268c0b68e94e56cfbab6ddbac9a31c8355091c98358a8b43d9a996a43c20807ee583f07f360e7745213a3accd157f95
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,26 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 0.1.0-alpha.29 (2025-08-24)
|
4
|
+
|
5
|
+
Full Changelog: [v0.1.0-alpha.28...v0.1.0-alpha.29](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.28...v0.1.0-alpha.29)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** api update ([a8f432a](https://github.com/Finch-API/finch-api-ruby/commit/a8f432a47e2e5ffbb1be53637b672383301d1baf))
|
10
|
+
|
11
|
+
|
12
|
+
### Chores
|
13
|
+
|
14
|
+
* add json schema comment for rubocop.yml ([9c458ab](https://github.com/Finch-API/finch-api-ruby/commit/9c458abf8ac902197c09eb4be5612d48d8d0723e))
|
15
|
+
|
16
|
+
## 0.1.0-alpha.28 (2025-08-20)
|
17
|
+
|
18
|
+
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)
|
19
|
+
|
20
|
+
### Features
|
21
|
+
|
22
|
+
* **api:** api update ([e615899](https://github.com/Finch-API/finch-api-ruby/commit/e615899d0e9c1243db7fa677f08411ef4c291bbd))
|
23
|
+
|
3
24
|
## 0.1.0-alpha.27 (2025-08-19)
|
4
25
|
|
5
26
|
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)
|
data/README.md
CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
17
17
|
<!-- x-release-please-start-version -->
|
18
18
|
|
19
19
|
```ruby
|
20
|
-
gem "finch-api", "~> 0.1.0.pre.alpha.
|
20
|
+
gem "finch-api", "~> 0.1.0.pre.alpha.29"
|
21
21
|
```
|
22
22
|
|
23
23
|
<!-- x-release-please-end -->
|
@@ -7,31 +7,39 @@ module FinchAPI
|
|
7
7
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
8
8
|
include FinchAPI::Internal::Type::RequestParameters
|
9
9
|
|
10
|
-
# @!attribute
|
10
|
+
# @!attribute client_id
|
11
|
+
# The client ID for your application
|
11
12
|
#
|
12
13
|
# @return [String]
|
13
|
-
required :
|
14
|
+
required :client_id, String
|
14
15
|
|
15
|
-
# @!attribute
|
16
|
+
# @!attribute client_secret
|
17
|
+
# The client secret for your application
|
16
18
|
#
|
17
|
-
# @return [String
|
18
|
-
|
19
|
+
# @return [String]
|
20
|
+
required :client_secret, String
|
19
21
|
|
20
|
-
# @!attribute
|
22
|
+
# @!attribute code
|
23
|
+
# The authorization code received from the authorization server
|
21
24
|
#
|
22
|
-
# @return [String
|
23
|
-
|
25
|
+
# @return [String]
|
26
|
+
required :code, String
|
24
27
|
|
25
28
|
# @!attribute redirect_uri
|
29
|
+
# The redirect URI used in the authorization request (optional)
|
26
30
|
#
|
27
31
|
# @return [String, nil]
|
28
32
|
optional :redirect_uri, String
|
29
33
|
|
30
|
-
# @!method initialize(
|
31
|
-
# @param
|
32
|
-
#
|
33
|
-
# @param client_secret [String]
|
34
|
-
#
|
34
|
+
# @!method initialize(client_id:, client_secret:, code:, redirect_uri: nil, request_options: {})
|
35
|
+
# @param client_id [String] The client ID for your application
|
36
|
+
#
|
37
|
+
# @param client_secret [String] The client secret for your application
|
38
|
+
#
|
39
|
+
# @param code [String] The authorization code received from the authorization server
|
40
|
+
#
|
41
|
+
# @param redirect_uri [String] The redirect URI used in the authorization request (optional)
|
42
|
+
#
|
35
43
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
36
44
|
end
|
37
45
|
end
|
@@ -5,37 +5,19 @@ module FinchAPI
|
|
5
5
|
# @see FinchAPI::Resources::AccessTokens#create
|
6
6
|
class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
|
7
7
|
# @!attribute access_token
|
8
|
-
# The access token for the connection
|
8
|
+
# The access token for the connection
|
9
9
|
#
|
10
10
|
# @return [String]
|
11
11
|
required :access_token, String
|
12
12
|
|
13
|
-
# @!attribute account_id
|
14
|
-
# @deprecated
|
15
|
-
#
|
16
|
-
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
17
|
-
# account ID.
|
18
|
-
#
|
19
|
-
# @return [String]
|
20
|
-
required :account_id, String
|
21
|
-
|
22
13
|
# @!attribute client_type
|
23
14
|
# The type of application associated with a token.
|
24
15
|
#
|
25
16
|
# @return [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType]
|
26
17
|
required :client_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ClientType }
|
27
18
|
|
28
|
-
# @!attribute company_id
|
29
|
-
# @deprecated
|
30
|
-
#
|
31
|
-
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
32
|
-
# company ID.
|
33
|
-
#
|
34
|
-
# @return [String]
|
35
|
-
required :company_id, String
|
36
|
-
|
37
19
|
# @!attribute connection_id
|
38
|
-
# The Finch UUID of the connection associated with the `access_token
|
20
|
+
# The Finch UUID of the connection associated with the `access_token`
|
39
21
|
#
|
40
22
|
# @return [String]
|
41
23
|
required :connection_id, String
|
@@ -50,53 +32,71 @@ module FinchAPI
|
|
50
32
|
required :connection_type, enum: -> { FinchAPI::CreateAccessTokenResponse::ConnectionType }
|
51
33
|
|
52
34
|
# @!attribute products
|
53
|
-
# An array of the authorized products associated with the `access_token
|
35
|
+
# An array of the authorized products associated with the `access_token`
|
54
36
|
#
|
55
37
|
# @return [Array<String>]
|
56
38
|
required :products, FinchAPI::Internal::Type::ArrayOf[String]
|
57
39
|
|
58
40
|
# @!attribute provider_id
|
59
|
-
# The ID of the provider associated with the `access_token
|
41
|
+
# The ID of the provider associated with the `access_token`
|
60
42
|
#
|
61
43
|
# @return [String]
|
62
44
|
required :provider_id, String
|
63
45
|
|
64
|
-
# @!attribute
|
65
|
-
# The
|
66
|
-
#
|
46
|
+
# @!attribute token_type
|
47
|
+
# The RFC 8693 token type (Finch uses `bearer` tokens)
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
required :token_type, String
|
51
|
+
|
52
|
+
# @!attribute account_id
|
53
|
+
# @deprecated
|
54
|
+
#
|
55
|
+
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
56
|
+
# account ID
|
67
57
|
#
|
68
58
|
# @return [String, nil]
|
69
|
-
optional :
|
59
|
+
optional :account_id, String
|
70
60
|
|
71
|
-
# @!attribute
|
72
|
-
#
|
61
|
+
# @!attribute company_id
|
62
|
+
# @deprecated
|
63
|
+
#
|
64
|
+
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
65
|
+
# company ID
|
66
|
+
#
|
67
|
+
# @return [String, nil]
|
68
|
+
optional :company_id, String
|
69
|
+
|
70
|
+
# @!attribute customer_id
|
71
|
+
# The ID of your customer you provided to Finch when a connect session was created
|
72
|
+
# for this connection
|
73
73
|
#
|
74
74
|
# @return [String, nil]
|
75
|
-
optional :
|
75
|
+
optional :customer_id, String, nil?: true
|
76
76
|
|
77
|
-
# @!method initialize(access_token:,
|
77
|
+
# @!method initialize(access_token:, client_type:, connection_id:, connection_type:, products:, provider_id:, token_type:, account_id: nil, company_id: nil, customer_id: nil)
|
78
78
|
# Some parameter documentations has been truncated, see
|
79
79
|
# {FinchAPI::Models::CreateAccessTokenResponse} for more details.
|
80
80
|
#
|
81
|
-
# @param access_token [String] The access token for the connection
|
82
|
-
#
|
83
|
-
# @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
|
81
|
+
# @param access_token [String] The access token for the connection
|
84
82
|
#
|
85
83
|
# @param client_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType] The type of application associated with a token.
|
86
84
|
#
|
87
|
-
# @param
|
88
|
-
#
|
89
|
-
# @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
|
85
|
+
# @param connection_id [String] The Finch UUID of the connection associated with the `access_token`
|
90
86
|
#
|
91
87
|
# @param connection_type [Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType] The type of the connection associated with the token.
|
92
88
|
#
|
93
|
-
# @param products [Array<String>] An array of the authorized products associated with the `access_token
|
94
|
-
#
|
95
|
-
# @param provider_id [String] The ID of the provider associated with the `access_token`.
|
89
|
+
# @param products [Array<String>] An array of the authorized products associated with the `access_token`
|
96
90
|
#
|
97
|
-
# @param
|
91
|
+
# @param provider_id [String] The ID of the provider associated with the `access_token`
|
98
92
|
#
|
99
93
|
# @param token_type [String] The RFC 8693 token type (Finch uses `bearer` tokens)
|
94
|
+
#
|
95
|
+
# @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
|
96
|
+
#
|
97
|
+
# @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
|
98
|
+
#
|
99
|
+
# @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created
|
100
100
|
|
101
101
|
# The type of application associated with a token.
|
102
102
|
#
|
@@ -104,8 +104,8 @@ module FinchAPI
|
|
104
104
|
module ClientType
|
105
105
|
extend FinchAPI::Internal::Type::Enum
|
106
106
|
|
107
|
-
PRODUCTION = :production
|
108
107
|
DEVELOPMENT = :development
|
108
|
+
PRODUCTION = :production
|
109
109
|
SANDBOX = :sandbox
|
110
110
|
|
111
111
|
# @!method self.values
|
@@ -121,8 +121,8 @@ module FinchAPI
|
|
121
121
|
module ConnectionType
|
122
122
|
extend FinchAPI::Internal::Type::Enum
|
123
123
|
|
124
|
-
PROVIDER = :provider
|
125
124
|
FINCH = :finch
|
125
|
+
PROVIDER = :provider
|
126
126
|
|
127
127
|
# @!method self.values
|
128
128
|
# @return [Array<Symbol>]
|