@@ -5,37 +5,19 @@ module Models
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,62 +32,80 @@ class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
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 customer_id
65
- # The ID of your customer you provided to Finch when a connect session was created
66
- # for this connection.
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 :customer_id , String , nil? : true
59
+ optional :account_id , String
70
60
71
- # @!attribute token_type
72
- # The RFC 8693 token type (Finch uses `bearer` tokens)
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 :token_type , String
75
+ optional :customer_id , String , nil? : true
76
76
77
- # @!method initialize(access_token:, account_id :, client_type :, company_id :, connection_id :, connection_type :, products :, provider_id:, customer_id : nil, token_type : nil)
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 company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
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 customer_id [String, nil ] The ID of your customer you provided to Finch when a connect session was created
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
#
103
103
# @see FinchAPI::Models::CreateAccessTokenResponse#client_type
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 ClientType
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>]
0 commit comments