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
@@ -11,27 +11,17 @@ module FinchAPI
|
|
11
11
|
)
|
12
12
|
end
|
13
13
|
|
14
|
-
# The access token for the connection
|
14
|
+
# The access token for the connection
|
15
15
|
sig { returns(String) }
|
16
16
|
attr_accessor :access_token
|
17
17
|
|
18
|
-
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
19
|
-
# account ID.
|
20
|
-
sig { returns(String) }
|
21
|
-
attr_accessor :account_id
|
22
|
-
|
23
18
|
# The type of application associated with a token.
|
24
19
|
sig do
|
25
20
|
returns(FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol)
|
26
21
|
end
|
27
22
|
attr_accessor :client_type
|
28
23
|
|
29
|
-
#
|
30
|
-
# company ID.
|
31
|
-
sig { returns(String) }
|
32
|
-
attr_accessor :company_id
|
33
|
-
|
34
|
-
# The Finch UUID of the connection associated with the `access_token`.
|
24
|
+
# The Finch UUID of the connection associated with the `access_token`
|
35
25
|
sig { returns(String) }
|
36
26
|
attr_accessor :connection_id
|
37
27
|
|
@@ -46,69 +36,82 @@ module FinchAPI
|
|
46
36
|
end
|
47
37
|
attr_accessor :connection_type
|
48
38
|
|
49
|
-
# An array of the authorized products associated with the `access_token
|
39
|
+
# An array of the authorized products associated with the `access_token`
|
50
40
|
sig { returns(T::Array[String]) }
|
51
41
|
attr_accessor :products
|
52
42
|
|
53
|
-
# The ID of the provider associated with the `access_token
|
43
|
+
# The ID of the provider associated with the `access_token`
|
54
44
|
sig { returns(String) }
|
55
45
|
attr_accessor :provider_id
|
56
46
|
|
57
|
-
# The
|
58
|
-
|
47
|
+
# The RFC 8693 token type (Finch uses `bearer` tokens)
|
48
|
+
sig { returns(String) }
|
49
|
+
attr_accessor :token_type
|
50
|
+
|
51
|
+
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
52
|
+
# account ID
|
59
53
|
sig { returns(T.nilable(String)) }
|
60
|
-
|
54
|
+
attr_reader :account_id
|
61
55
|
|
62
|
-
|
56
|
+
sig { params(account_id: String).void }
|
57
|
+
attr_writer :account_id
|
58
|
+
|
59
|
+
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
60
|
+
# company ID
|
63
61
|
sig { returns(T.nilable(String)) }
|
64
|
-
attr_reader :
|
62
|
+
attr_reader :company_id
|
63
|
+
|
64
|
+
sig { params(company_id: String).void }
|
65
|
+
attr_writer :company_id
|
65
66
|
|
66
|
-
|
67
|
-
|
67
|
+
# The ID of your customer you provided to Finch when a connect session was created
|
68
|
+
# for this connection
|
69
|
+
sig { returns(T.nilable(String)) }
|
70
|
+
attr_accessor :customer_id
|
68
71
|
|
69
72
|
sig do
|
70
73
|
params(
|
71
74
|
access_token: String,
|
72
|
-
account_id: String,
|
73
75
|
client_type:
|
74
76
|
FinchAPI::CreateAccessTokenResponse::ClientType::OrSymbol,
|
75
|
-
company_id: String,
|
76
77
|
connection_id: String,
|
77
78
|
connection_type:
|
78
79
|
FinchAPI::CreateAccessTokenResponse::ConnectionType::OrSymbol,
|
79
80
|
products: T::Array[String],
|
80
81
|
provider_id: String,
|
81
|
-
|
82
|
-
|
82
|
+
token_type: String,
|
83
|
+
account_id: String,
|
84
|
+
company_id: String,
|
85
|
+
customer_id: T.nilable(String)
|
83
86
|
).returns(T.attached_class)
|
84
87
|
end
|
85
88
|
def self.new(
|
86
|
-
# The access token for the connection
|
89
|
+
# The access token for the connection
|
87
90
|
access_token:,
|
88
|
-
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
89
|
-
# account ID.
|
90
|
-
account_id:,
|
91
91
|
# The type of application associated with a token.
|
92
92
|
client_type:,
|
93
|
-
#
|
94
|
-
# company ID.
|
95
|
-
company_id:,
|
96
|
-
# The Finch UUID of the connection associated with the `access_token`.
|
93
|
+
# The Finch UUID of the connection associated with the `access_token`
|
97
94
|
connection_id:,
|
98
95
|
# The type of the connection associated with the token.
|
99
96
|
#
|
100
97
|
# - `provider` - connection to an external provider
|
101
98
|
# - `finch` - finch-generated data.
|
102
99
|
connection_type:,
|
103
|
-
# An array of the authorized products associated with the `access_token
|
100
|
+
# An array of the authorized products associated with the `access_token`
|
104
101
|
products:,
|
105
|
-
# The ID of the provider associated with the `access_token
|
102
|
+
# The ID of the provider associated with the `access_token`
|
106
103
|
provider_id:,
|
107
|
-
# The ID of your customer you provided to Finch when a connect session was created
|
108
|
-
# for this connection.
|
109
|
-
customer_id: nil,
|
110
104
|
# The RFC 8693 token type (Finch uses `bearer` tokens)
|
111
|
-
token_type
|
105
|
+
token_type:,
|
106
|
+
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
107
|
+
# account ID
|
108
|
+
account_id: nil,
|
109
|
+
# [DEPRECATED] Use `connection_id` to identify the connection instead of this
|
110
|
+
# company ID
|
111
|
+
company_id: nil,
|
112
|
+
# The ID of your customer you provided to Finch when a connect session was created
|
113
|
+
# for this connection
|
114
|
+
customer_id: nil
|
112
115
|
)
|
113
116
|
end
|
114
117
|
|
@@ -116,17 +119,17 @@ module FinchAPI
|
|
116
119
|
override.returns(
|
117
120
|
{
|
118
121
|
access_token: String,
|
119
|
-
account_id: String,
|
120
122
|
client_type:
|
121
123
|
FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol,
|
122
|
-
company_id: String,
|
123
124
|
connection_id: String,
|
124
125
|
connection_type:
|
125
126
|
FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol,
|
126
127
|
products: T::Array[String],
|
127
128
|
provider_id: String,
|
128
|
-
|
129
|
-
|
129
|
+
token_type: String,
|
130
|
+
account_id: String,
|
131
|
+
company_id: String,
|
132
|
+
customer_id: T.nilable(String)
|
130
133
|
}
|
131
134
|
)
|
132
135
|
end
|
@@ -143,14 +146,14 @@ module FinchAPI
|
|
143
146
|
end
|
144
147
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
145
148
|
|
146
|
-
|
149
|
+
DEVELOPMENT =
|
147
150
|
T.let(
|
148
|
-
:
|
151
|
+
:development,
|
149
152
|
FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol
|
150
153
|
)
|
151
|
-
|
154
|
+
PRODUCTION =
|
152
155
|
T.let(
|
153
|
-
:
|
156
|
+
:production,
|
154
157
|
FinchAPI::CreateAccessTokenResponse::ClientType::TaggedSymbol
|
155
158
|
)
|
156
159
|
SANDBOX =
|
@@ -183,14 +186,14 @@ module FinchAPI
|
|
183
186
|
end
|
184
187
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
185
188
|
|
186
|
-
|
189
|
+
FINCH =
|
187
190
|
T.let(
|
188
|
-
:
|
191
|
+
:finch,
|
189
192
|
FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol
|
190
193
|
)
|
191
|
-
|
194
|
+
PROVIDER =
|
192
195
|
T.let(
|
193
|
-
:
|
196
|
+
:provider,
|
194
197
|
FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol
|
195
198
|
)
|
196
199
|
|