finch-api 0.1.0.pre.alpha.30 → 0.1.0.pre.alpha.31
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 +40 -0
- data/README.md +1 -1
- data/lib/finch_api/errors.rb +25 -11
- data/lib/finch_api/file_part.rb +10 -7
- data/lib/finch_api/internal/individuals_page.rb +1 -1
- data/lib/finch_api/internal/page.rb +1 -1
- data/lib/finch_api/internal/responses_page.rb +1 -1
- data/lib/finch_api/internal/single_page.rb +1 -1
- data/lib/finch_api/internal/transport/base_client.rb +11 -7
- data/lib/finch_api/internal/transport/pooled_net_requester.rb +34 -31
- data/lib/finch_api/internal/type/base_page.rb +1 -1
- data/lib/finch_api/internal/type/file_input.rb +7 -4
- data/lib/finch_api/internal/util.rb +8 -7
- data/lib/finch_api/models/connect/session_new_params.rb +66 -50
- data/lib/finch_api/models/connect/session_reauthenticate_params.rb +10 -10
- data/lib/finch_api/models/create_access_token_response.rb +9 -1
- data/lib/finch_api/models/hris/benefit_contribution.rb +124 -29
- data/lib/finch_api/models/hris/benefit_create_params.rb +9 -1
- data/lib/finch_api/models/hris/benefit_list_params.rb +9 -1
- data/lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb +9 -1
- data/lib/finch_api/models/hris/benefit_retrieve_params.rb +9 -1
- data/lib/finch_api/models/hris/benefit_update_params.rb +9 -1
- data/lib/finch_api/models/hris/benefits/individual_benefit.rb +222 -6
- data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +40 -2
- data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +9 -1
- data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +9 -1
- data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +9 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_create_params.rb +9 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +9 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_list_params.rb +9 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +10 -1
- data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb +9 -1
- data/lib/finch_api/models/hris/company_retrieve_params.rb +9 -1
- data/lib/finch_api/models/hris/directory_list_individuals_params.rb +9 -1
- data/lib/finch_api/models/hris/directory_list_params.rb +9 -1
- data/lib/finch_api/models/hris/document_list_params.rb +9 -1
- data/lib/finch_api/models/hris/document_response.rb +11 -11
- data/lib/finch_api/models/hris/document_retreive_params.rb +9 -1
- data/lib/finch_api/models/hris/employment_retrieve_many_params.rb +9 -1
- data/lib/finch_api/models/hris/individual_retrieve_many_params.rb +11 -1
- data/lib/finch_api/models/hris/pay_statement.rb +11 -15
- data/lib/finch_api/models/hris/pay_statement_retrieve_many_params.rb +9 -1
- data/lib/finch_api/models/hris/payment_list_params.rb +9 -1
- data/lib/finch_api/models/hris/supported_benefit.rb +1 -0
- data/lib/finch_api/models/hris/w42005.rb +20 -20
- data/lib/finch_api/models/hris/w42020.rb +30 -30
- data/lib/finch_api/models/introspection.rb +38 -23
- data/lib/finch_api/models/jobs/automated_list_params.rb +1 -14
- data/lib/finch_api/models/jobs/automated_retrieve_params.rb +1 -14
- data/lib/finch_api/models/jobs/manual_retrieve_params.rb +1 -14
- data/lib/finch_api/models/payroll/pay_group_list_params.rb +11 -1
- data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +9 -1
- data/lib/finch_api/models/provider.rb +42 -1092
- data/lib/finch_api/models/provider_list_response.rb +143 -0
- data/lib/finch_api/models/request_forwarding_forward_params.rb +10 -6
- data/lib/finch_api/models/request_forwarding_forward_response.rb +69 -48
- data/lib/finch_api/resources/connect/sessions.rb +12 -12
- data/lib/finch_api/resources/hris/benefits/individuals.rb +24 -10
- data/lib/finch_api/resources/hris/benefits.rb +37 -16
- data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +38 -15
- data/lib/finch_api/resources/hris/company/pay_statement_item.rb +3 -1
- data/lib/finch_api/resources/hris/company.rb +6 -2
- data/lib/finch_api/resources/hris/directory.rb +3 -1
- data/lib/finch_api/resources/hris/documents.rb +9 -3
- data/lib/finch_api/resources/hris/employments.rb +7 -3
- data/lib/finch_api/resources/hris/individuals.rb +10 -4
- data/lib/finch_api/resources/hris/pay_statements.rb +7 -3
- data/lib/finch_api/resources/hris/payments.rb +3 -1
- data/lib/finch_api/resources/jobs/automated.rb +3 -16
- data/lib/finch_api/resources/jobs/manual.rb +2 -10
- data/lib/finch_api/resources/payroll/pay_groups.rb +12 -3
- data/lib/finch_api/resources/providers.rb +2 -2
- data/lib/finch_api/resources/request_forwarding.rb +2 -2
- data/lib/finch_api/version.rb +1 -1
- data/lib/finch_api.rb +1 -0
- data/rbi/finch_api/errors.rbi +29 -2
- data/rbi/finch_api/file_part.rbi +1 -1
- data/rbi/finch_api/internal/transport/base_client.rbi +4 -5
- data/rbi/finch_api/internal/type/base_page.rbi +1 -1
- data/rbi/finch_api/internal/util.rbi +1 -1
- data/rbi/finch_api/models/connect/session_new_params.rbi +124 -98
- data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +23 -23
- data/rbi/finch_api/models/create_access_token_response.rbi +8 -0
- data/rbi/finch_api/models/hris/benefit_contribution.rbi +270 -52
- data/rbi/finch_api/models/hris/benefit_create_params.rbi +11 -0
- data/rbi/finch_api/models/hris/benefit_list_params.rbi +24 -5
- data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi +24 -5
- data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +24 -5
- data/rbi/finch_api/models/hris/benefit_update_params.rbi +15 -1
- data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +515 -20
- data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +87 -0
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +22 -5
- data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +11 -0
- data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +11 -0
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbi +11 -0
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +22 -5
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbi +22 -5
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +15 -1
- data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi +11 -0
- data/rbi/finch_api/models/hris/company_retrieve_params.rbi +24 -5
- data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi +11 -0
- data/rbi/finch_api/models/hris/directory_list_params.rbi +11 -0
- data/rbi/finch_api/models/hris/document_list_params.rbi +11 -0
- data/rbi/finch_api/models/hris/document_response.rbi +14 -29
- data/rbi/finch_api/models/hris/document_retreive_params.rbi +24 -5
- data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi +11 -0
- data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi +16 -1
- data/rbi/finch_api/models/hris/pay_statement.rbi +9 -34
- data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi +11 -0
- data/rbi/finch_api/models/hris/payment_list_params.rbi +11 -0
- data/rbi/finch_api/models/hris/supported_benefit.rbi +5 -0
- data/rbi/finch_api/models/hris/w42005.rbi +28 -38
- data/rbi/finch_api/models/hris/w42020.rbi +37 -43
- data/rbi/finch_api/models/introspection.rbi +57 -33
- data/rbi/finch_api/models/jobs/automated_list_params.rbi +0 -15
- data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +5 -25
- data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +5 -25
- data/rbi/finch_api/models/payroll/pay_group_list_params.rbi +11 -0
- data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +24 -5
- data/rbi/finch_api/models/provider.rbi +75 -2507
- data/rbi/finch_api/models/provider_list_response.rbi +280 -0
- data/rbi/finch_api/models/request_forwarding_forward_params.rbi +6 -6
- data/rbi/finch_api/models/request_forwarding_forward_response.rbi +93 -60
- data/rbi/finch_api/resources/connect/sessions.rbi +22 -14
- data/rbi/finch_api/resources/hris/benefits/individuals.rbi +20 -3
- data/rbi/finch_api/resources/hris/benefits.rbi +39 -12
- data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +35 -8
- data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +3 -0
- data/rbi/finch_api/resources/hris/company.rbi +9 -4
- data/rbi/finch_api/resources/hris/directory.rbi +3 -0
- data/rbi/finch_api/resources/hris/documents.rbi +6 -0
- data/rbi/finch_api/resources/hris/employments.rbi +4 -1
- data/rbi/finch_api/resources/hris/individuals.rbi +10 -1
- data/rbi/finch_api/resources/hris/pay_statements.rbi +4 -1
- data/rbi/finch_api/resources/hris/payments.rbi +3 -0
- data/rbi/finch_api/resources/jobs/automated.rbi +1 -14
- data/rbi/finch_api/resources/jobs/manual.rbi +1 -9
- data/rbi/finch_api/resources/payroll/pay_groups.rbi +15 -2
- data/rbi/finch_api/resources/providers.rbi +1 -1
- data/rbi/finch_api/resources/request_forwarding.rbi +2 -2
- data/sig/finch_api/errors.rbs +7 -0
- data/sig/finch_api/file_part.rbs +1 -1
- data/sig/finch_api/models/connect/session_new_params.rbs +45 -45
- data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +15 -15
- data/sig/finch_api/models/create_access_token_response.rbs +5 -0
- data/sig/finch_api/models/hris/benefit_contribution.rbs +107 -21
- data/sig/finch_api/models/hris/benefit_create_params.rbs +7 -0
- data/sig/finch_api/models/hris/benefit_list_params.rbs +14 -3
- data/sig/finch_api/models/hris/benefit_list_supported_benefits_params.rbs +14 -3
- data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +14 -3
- data/sig/finch_api/models/hris/benefit_update_params.rbs +8 -1
- data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +201 -8
- data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +30 -1
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +14 -3
- data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +7 -1
- data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +7 -1
- data/sig/finch_api/models/hris/benfit_contribution.rbs +1 -1
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_create_params.rbs +7 -0
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +14 -3
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_list_params.rbs +14 -3
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +7 -1
- data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs +7 -0
- data/sig/finch_api/models/hris/company_retrieve_params.rbs +14 -3
- data/sig/finch_api/models/hris/directory_list_individuals_params.rbs +7 -1
- data/sig/finch_api/models/hris/directory_list_params.rbs +7 -1
- data/sig/finch_api/models/hris/document_list_params.rbs +7 -0
- data/sig/finch_api/models/hris/document_response.rbs +11 -19
- data/sig/finch_api/models/hris/document_retreive_params.rbs +14 -3
- data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs +8 -1
- data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs +7 -0
- data/sig/finch_api/models/hris/pay_statement.rbs +12 -12
- data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs +8 -1
- data/sig/finch_api/models/hris/payment_list_params.rbs +7 -1
- data/sig/finch_api/models/hris/supported_benefit.rbs +2 -1
- data/sig/finch_api/models/hris/w42005.rbs +23 -37
- data/sig/finch_api/models/hris/w42020.rbs +35 -45
- data/sig/finch_api/models/introspection.rbs +29 -20
- data/sig/finch_api/models/jobs/automated_list_params.rbs +1 -7
- data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +3 -13
- data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +3 -13
- data/sig/finch_api/models/payroll/pay_group_list_params.rbs +11 -1
- data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +14 -3
- data/sig/finch_api/models/provider.rbs +31 -1366
- data/sig/finch_api/models/provider_list_response.rbs +128 -0
- data/sig/finch_api/models/request_forwarding_forward_params.rbs +8 -8
- data/sig/finch_api/models/request_forwarding_forward_response.rbs +40 -30
- data/sig/finch_api/resources/connect/sessions.rbs +9 -9
- data/sig/finch_api/resources/hris/benefits/individuals.rbs +4 -0
- data/sig/finch_api/resources/hris/benefits.rbs +5 -0
- data/sig/finch_api/resources/hris/company/pay_statement_item/rules.rbs +4 -0
- data/sig/finch_api/resources/hris/company/pay_statement_item.rbs +1 -0
- data/sig/finch_api/resources/hris/company.rbs +1 -0
- data/sig/finch_api/resources/hris/directory.rbs +1 -0
- data/sig/finch_api/resources/hris/documents.rbs +2 -0
- data/sig/finch_api/resources/hris/employments.rbs +1 -0
- data/sig/finch_api/resources/hris/individuals.rbs +1 -0
- data/sig/finch_api/resources/hris/pay_statements.rbs +1 -0
- data/sig/finch_api/resources/hris/payments.rbs +1 -0
- data/sig/finch_api/resources/jobs/automated.rbs +0 -2
- data/sig/finch_api/resources/jobs/manual.rbs +0 -1
- data/sig/finch_api/resources/payroll/pay_groups.rbs +2 -0
- data/sig/finch_api/resources/providers.rbs +1 -1
- data/sig/finch_api/resources/request_forwarding.rbs +2 -2
- metadata +5 -2
|
@@ -2,16 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
module FinchAPI
|
|
4
4
|
module Models
|
|
5
|
-
# @see FinchAPI::Resources::Providers#list
|
|
6
5
|
class Provider < FinchAPI::Internal::Type::BaseModel
|
|
7
6
|
# @!attribute id
|
|
8
7
|
# The id of the payroll provider used in Connect.
|
|
9
8
|
#
|
|
10
|
-
# @return [String
|
|
11
|
-
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute display_name
|
|
13
|
+
# The display name of the payroll provider.
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :display_name, String
|
|
17
|
+
|
|
18
|
+
# @!attribute products
|
|
19
|
+
# The list of Finch products supported on this payroll provider.
|
|
20
|
+
#
|
|
21
|
+
# @return [Array<String>]
|
|
22
|
+
required :products, FinchAPI::Internal::Type::ArrayOf[String]
|
|
12
23
|
|
|
13
24
|
# @!attribute authentication_methods
|
|
14
|
-
# The
|
|
25
|
+
# The authentication methods supported by the provider.
|
|
15
26
|
#
|
|
16
27
|
# @return [Array<FinchAPI::Models::Provider::AuthenticationMethod>, nil]
|
|
17
28
|
optional :authentication_methods,
|
|
@@ -23,12 +34,6 @@ module FinchAPI
|
|
|
23
34
|
# @return [Boolean, nil]
|
|
24
35
|
optional :beta, FinchAPI::Internal::Type::Boolean
|
|
25
36
|
|
|
26
|
-
# @!attribute display_name
|
|
27
|
-
# The display name of the payroll provider.
|
|
28
|
-
#
|
|
29
|
-
# @return [String, nil]
|
|
30
|
-
optional :display_name, String
|
|
31
|
-
|
|
32
37
|
# @!attribute icon
|
|
33
38
|
# The url to the official icon of the payroll provider.
|
|
34
39
|
#
|
|
@@ -42,6 +47,8 @@ module FinchAPI
|
|
|
42
47
|
optional :logo, String
|
|
43
48
|
|
|
44
49
|
# @!attribute manual
|
|
50
|
+
# @deprecated
|
|
51
|
+
#
|
|
45
52
|
# [DEPRECATED] Whether the Finch integration with this provider uses the Assisted
|
|
46
53
|
# Connect Flow by default. This field is now deprecated. Please check for a `type`
|
|
47
54
|
# of `assisted` in the `authentication_methods` field instead.
|
|
@@ -61,23 +68,19 @@ module FinchAPI
|
|
|
61
68
|
# @return [String, nil]
|
|
62
69
|
optional :primary_color, String
|
|
63
70
|
|
|
64
|
-
# @!
|
|
65
|
-
# The list of Finch products supported on this payroll provider.
|
|
66
|
-
#
|
|
67
|
-
# @return [Array<String>, nil]
|
|
68
|
-
optional :products, FinchAPI::Internal::Type::ArrayOf[String]
|
|
69
|
-
|
|
70
|
-
# @!method initialize(id: nil, authentication_methods: nil, beta: nil, display_name: nil, icon: nil, logo: nil, manual: nil, mfa_required: nil, primary_color: nil, products: nil)
|
|
71
|
+
# @!method initialize(id:, display_name:, products:, authentication_methods: nil, beta: nil, icon: nil, logo: nil, manual: nil, mfa_required: nil, primary_color: nil)
|
|
71
72
|
# Some parameter documentations has been truncated, see
|
|
72
73
|
# {FinchAPI::Models::Provider} for more details.
|
|
73
74
|
#
|
|
74
75
|
# @param id [String] The id of the payroll provider used in Connect.
|
|
75
76
|
#
|
|
76
|
-
# @param
|
|
77
|
+
# @param display_name [String] The display name of the payroll provider.
|
|
77
78
|
#
|
|
78
|
-
# @param
|
|
79
|
+
# @param products [Array<String>] The list of Finch products supported on this payroll provider.
|
|
79
80
|
#
|
|
80
|
-
# @param
|
|
81
|
+
# @param authentication_methods [Array<FinchAPI::Models::Provider::AuthenticationMethod>] The authentication methods supported by the provider.
|
|
82
|
+
#
|
|
83
|
+
# @param beta [Boolean] `true` if the integration is in a beta state, `false` otherwise
|
|
81
84
|
#
|
|
82
85
|
# @param icon [String] The url to the official icon of the payroll provider.
|
|
83
86
|
#
|
|
@@ -88,1090 +91,36 @@ module FinchAPI
|
|
|
88
91
|
# @param mfa_required [Boolean] whether MFA is required for the provider.
|
|
89
92
|
#
|
|
90
93
|
# @param primary_color [String] The hex code for the primary color of the payroll provider.
|
|
91
|
-
#
|
|
92
|
-
# @param products [Array<String>] The list of Finch products supported on this payroll provider.
|
|
93
94
|
|
|
94
95
|
class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
|
|
96
|
+
# @!attribute type
|
|
97
|
+
# The type of authentication method
|
|
98
|
+
#
|
|
99
|
+
# @return [Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type]
|
|
100
|
+
required :type, enum: -> { FinchAPI::Provider::AuthenticationMethod::Type }
|
|
101
|
+
|
|
95
102
|
# @!attribute benefits_support
|
|
96
|
-
#
|
|
97
|
-
# supported, the property will be null
|
|
103
|
+
# The supported benefit types and their configurations
|
|
98
104
|
#
|
|
99
|
-
# @return [
|
|
100
|
-
optional :benefits_support,
|
|
105
|
+
# @return [Hash{Symbol=>Object, nil}, nil]
|
|
106
|
+
optional :benefits_support,
|
|
107
|
+
FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
|
|
101
108
|
|
|
102
109
|
# @!attribute supported_fields
|
|
103
|
-
# The supported
|
|
110
|
+
# The supported fields for each Finch product
|
|
104
111
|
#
|
|
105
|
-
# @return [
|
|
112
|
+
# @return [Hash{Symbol=>Object, nil}, nil]
|
|
106
113
|
optional :supported_fields,
|
|
107
|
-
|
|
108
|
-
FinchAPI::Provider::AuthenticationMethod::SupportedFields
|
|
109
|
-
},
|
|
110
|
-
nil?: true
|
|
114
|
+
FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
|
|
111
115
|
|
|
112
|
-
# @!
|
|
113
|
-
# The type of authentication method
|
|
114
|
-
#
|
|
115
|
-
# @return [Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type, nil]
|
|
116
|
-
optional :type, enum: -> { FinchAPI::Provider::AuthenticationMethod::Type }
|
|
117
|
-
|
|
118
|
-
# @!method initialize(benefits_support: nil, supported_fields: nil, type: nil)
|
|
119
|
-
# Some parameter documentations has been truncated, see
|
|
120
|
-
# {FinchAPI::Models::Provider::AuthenticationMethod} for more details.
|
|
121
|
-
#
|
|
122
|
-
# @param benefits_support [FinchAPI::Models::HRIS::BenefitsSupport, nil] Each benefit type and their supported features. If the benefit type is not suppo
|
|
116
|
+
# @!method initialize(type:, benefits_support: nil, supported_fields: nil)
|
|
117
|
+
# @param type [Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type] The type of authentication method
|
|
123
118
|
#
|
|
124
|
-
# @param
|
|
119
|
+
# @param benefits_support [Hash{Symbol=>Object, nil}] The supported benefit types and their configurations
|
|
125
120
|
#
|
|
126
|
-
# @param
|
|
127
|
-
|
|
128
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod#supported_fields
|
|
129
|
-
class SupportedFields < FinchAPI::Internal::Type::BaseModel
|
|
130
|
-
# @!attribute company
|
|
131
|
-
#
|
|
132
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, nil]
|
|
133
|
-
optional :company, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company }
|
|
134
|
-
|
|
135
|
-
# @!attribute directory
|
|
136
|
-
#
|
|
137
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, nil]
|
|
138
|
-
optional :directory, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory }
|
|
139
|
-
|
|
140
|
-
# @!attribute employment
|
|
141
|
-
#
|
|
142
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, nil]
|
|
143
|
-
optional :employment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment }
|
|
144
|
-
|
|
145
|
-
# @!attribute individual
|
|
146
|
-
#
|
|
147
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, nil]
|
|
148
|
-
optional :individual, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual }
|
|
149
|
-
|
|
150
|
-
# @!attribute pay_group
|
|
151
|
-
#
|
|
152
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, nil]
|
|
153
|
-
optional :pay_group, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayGroup }
|
|
154
|
-
|
|
155
|
-
# @!attribute pay_statement
|
|
156
|
-
#
|
|
157
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, nil]
|
|
158
|
-
optional :pay_statement, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement }
|
|
159
|
-
|
|
160
|
-
# @!attribute payment
|
|
161
|
-
#
|
|
162
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, nil]
|
|
163
|
-
optional :payment, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment }
|
|
164
|
-
|
|
165
|
-
# @!method initialize(company: nil, directory: nil, employment: nil, individual: nil, pay_group: nil, pay_statement: nil, payment: nil)
|
|
166
|
-
# The supported data fields returned by our HR and payroll endpoints
|
|
167
|
-
#
|
|
168
|
-
# @param company [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company]
|
|
169
|
-
# @param directory [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory]
|
|
170
|
-
# @param employment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment]
|
|
171
|
-
# @param individual [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual]
|
|
172
|
-
# @param pay_group [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup]
|
|
173
|
-
# @param pay_statement [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement]
|
|
174
|
-
# @param payment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment]
|
|
175
|
-
|
|
176
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#company
|
|
177
|
-
class Company < FinchAPI::Internal::Type::BaseModel
|
|
178
|
-
# @!attribute id
|
|
179
|
-
#
|
|
180
|
-
# @return [Boolean, nil]
|
|
181
|
-
optional :id, FinchAPI::Internal::Type::Boolean
|
|
182
|
-
|
|
183
|
-
# @!attribute accounts
|
|
184
|
-
#
|
|
185
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, nil]
|
|
186
|
-
optional :accounts, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Accounts }
|
|
187
|
-
|
|
188
|
-
# @!attribute departments
|
|
189
|
-
#
|
|
190
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, nil]
|
|
191
|
-
optional :departments,
|
|
192
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments }
|
|
193
|
-
|
|
194
|
-
# @!attribute ein
|
|
195
|
-
#
|
|
196
|
-
# @return [Boolean, nil]
|
|
197
|
-
optional :ein, FinchAPI::Internal::Type::Boolean
|
|
198
|
-
|
|
199
|
-
# @!attribute entity
|
|
200
|
-
#
|
|
201
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, nil]
|
|
202
|
-
optional :entity, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Entity }
|
|
203
|
-
|
|
204
|
-
# @!attribute legal_name
|
|
205
|
-
#
|
|
206
|
-
# @return [Boolean, nil]
|
|
207
|
-
optional :legal_name, FinchAPI::Internal::Type::Boolean
|
|
208
|
-
|
|
209
|
-
# @!attribute locations
|
|
210
|
-
#
|
|
211
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, nil]
|
|
212
|
-
optional :locations, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Locations }
|
|
213
|
-
|
|
214
|
-
# @!attribute primary_email
|
|
215
|
-
#
|
|
216
|
-
# @return [Boolean, nil]
|
|
217
|
-
optional :primary_email, FinchAPI::Internal::Type::Boolean
|
|
218
|
-
|
|
219
|
-
# @!attribute primary_phone_number
|
|
220
|
-
#
|
|
221
|
-
# @return [Boolean, nil]
|
|
222
|
-
optional :primary_phone_number, FinchAPI::Internal::Type::Boolean
|
|
223
|
-
|
|
224
|
-
# @!method initialize(id: nil, accounts: nil, departments: nil, ein: nil, entity: nil, legal_name: nil, locations: nil, primary_email: nil, primary_phone_number: nil)
|
|
225
|
-
# @param id [Boolean]
|
|
226
|
-
# @param accounts [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts]
|
|
227
|
-
# @param departments [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments]
|
|
228
|
-
# @param ein [Boolean]
|
|
229
|
-
# @param entity [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity]
|
|
230
|
-
# @param legal_name [Boolean]
|
|
231
|
-
# @param locations [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations]
|
|
232
|
-
# @param primary_email [Boolean]
|
|
233
|
-
# @param primary_phone_number [Boolean]
|
|
234
|
-
|
|
235
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#accounts
|
|
236
|
-
class Accounts < FinchAPI::Internal::Type::BaseModel
|
|
237
|
-
# @!attribute account_name
|
|
238
|
-
#
|
|
239
|
-
# @return [Boolean, nil]
|
|
240
|
-
optional :account_name, FinchAPI::Internal::Type::Boolean
|
|
241
|
-
|
|
242
|
-
# @!attribute account_number
|
|
243
|
-
#
|
|
244
|
-
# @return [Boolean, nil]
|
|
245
|
-
optional :account_number, FinchAPI::Internal::Type::Boolean
|
|
246
|
-
|
|
247
|
-
# @!attribute account_type
|
|
248
|
-
#
|
|
249
|
-
# @return [Boolean, nil]
|
|
250
|
-
optional :account_type, FinchAPI::Internal::Type::Boolean
|
|
251
|
-
|
|
252
|
-
# @!attribute institution_name
|
|
253
|
-
#
|
|
254
|
-
# @return [Boolean, nil]
|
|
255
|
-
optional :institution_name, FinchAPI::Internal::Type::Boolean
|
|
256
|
-
|
|
257
|
-
# @!attribute routing_number
|
|
258
|
-
#
|
|
259
|
-
# @return [Boolean, nil]
|
|
260
|
-
optional :routing_number, FinchAPI::Internal::Type::Boolean
|
|
261
|
-
|
|
262
|
-
# @!method initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil)
|
|
263
|
-
# @param account_name [Boolean]
|
|
264
|
-
# @param account_number [Boolean]
|
|
265
|
-
# @param account_type [Boolean]
|
|
266
|
-
# @param institution_name [Boolean]
|
|
267
|
-
# @param routing_number [Boolean]
|
|
268
|
-
end
|
|
269
|
-
|
|
270
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#departments
|
|
271
|
-
class Departments < FinchAPI::Internal::Type::BaseModel
|
|
272
|
-
# @!attribute name
|
|
273
|
-
#
|
|
274
|
-
# @return [Boolean, nil]
|
|
275
|
-
optional :name, FinchAPI::Internal::Type::Boolean
|
|
276
|
-
|
|
277
|
-
# @!attribute parent
|
|
278
|
-
#
|
|
279
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, nil]
|
|
280
|
-
optional :parent,
|
|
281
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent }
|
|
282
|
-
|
|
283
|
-
# @!method initialize(name: nil, parent: nil)
|
|
284
|
-
# @param name [Boolean]
|
|
285
|
-
# @param parent [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent]
|
|
286
|
-
|
|
287
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments#parent
|
|
288
|
-
class Parent < FinchAPI::Internal::Type::BaseModel
|
|
289
|
-
# @!attribute name
|
|
290
|
-
#
|
|
291
|
-
# @return [Boolean, nil]
|
|
292
|
-
optional :name, FinchAPI::Internal::Type::Boolean
|
|
293
|
-
|
|
294
|
-
# @!method initialize(name: nil)
|
|
295
|
-
# @param name [Boolean]
|
|
296
|
-
end
|
|
297
|
-
end
|
|
298
|
-
|
|
299
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#entity
|
|
300
|
-
class Entity < FinchAPI::Internal::Type::BaseModel
|
|
301
|
-
# @!attribute subtype
|
|
302
|
-
#
|
|
303
|
-
# @return [Boolean, nil]
|
|
304
|
-
optional :subtype, FinchAPI::Internal::Type::Boolean
|
|
305
|
-
|
|
306
|
-
# @!attribute type
|
|
307
|
-
#
|
|
308
|
-
# @return [Boolean, nil]
|
|
309
|
-
optional :type, FinchAPI::Internal::Type::Boolean
|
|
310
|
-
|
|
311
|
-
# @!method initialize(subtype: nil, type: nil)
|
|
312
|
-
# @param subtype [Boolean]
|
|
313
|
-
# @param type [Boolean]
|
|
314
|
-
end
|
|
315
|
-
|
|
316
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company#locations
|
|
317
|
-
class Locations < FinchAPI::Internal::Type::BaseModel
|
|
318
|
-
# @!attribute city
|
|
319
|
-
#
|
|
320
|
-
# @return [Boolean, nil]
|
|
321
|
-
optional :city, FinchAPI::Internal::Type::Boolean
|
|
322
|
-
|
|
323
|
-
# @!attribute country
|
|
324
|
-
#
|
|
325
|
-
# @return [Boolean, nil]
|
|
326
|
-
optional :country, FinchAPI::Internal::Type::Boolean
|
|
327
|
-
|
|
328
|
-
# @!attribute line1
|
|
329
|
-
#
|
|
330
|
-
# @return [Boolean, nil]
|
|
331
|
-
optional :line1, FinchAPI::Internal::Type::Boolean
|
|
332
|
-
|
|
333
|
-
# @!attribute line2
|
|
334
|
-
#
|
|
335
|
-
# @return [Boolean, nil]
|
|
336
|
-
optional :line2, FinchAPI::Internal::Type::Boolean
|
|
337
|
-
|
|
338
|
-
# @!attribute postal_code
|
|
339
|
-
#
|
|
340
|
-
# @return [Boolean, nil]
|
|
341
|
-
optional :postal_code, FinchAPI::Internal::Type::Boolean
|
|
342
|
-
|
|
343
|
-
# @!attribute state
|
|
344
|
-
#
|
|
345
|
-
# @return [Boolean, nil]
|
|
346
|
-
optional :state, FinchAPI::Internal::Type::Boolean
|
|
347
|
-
|
|
348
|
-
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
|
349
|
-
# @param city [Boolean]
|
|
350
|
-
# @param country [Boolean]
|
|
351
|
-
# @param line1 [Boolean]
|
|
352
|
-
# @param line2 [Boolean]
|
|
353
|
-
# @param postal_code [Boolean]
|
|
354
|
-
# @param state [Boolean]
|
|
355
|
-
end
|
|
356
|
-
end
|
|
357
|
-
|
|
358
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#directory
|
|
359
|
-
class Directory < FinchAPI::Internal::Type::BaseModel
|
|
360
|
-
# @!attribute individuals
|
|
361
|
-
#
|
|
362
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, nil]
|
|
363
|
-
optional :individuals,
|
|
364
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals }
|
|
365
|
-
|
|
366
|
-
# @!attribute paging
|
|
367
|
-
#
|
|
368
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, nil]
|
|
369
|
-
optional :paging, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Paging }
|
|
370
|
-
|
|
371
|
-
# @!method initialize(individuals: nil, paging: nil)
|
|
372
|
-
# @param individuals [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals]
|
|
373
|
-
# @param paging [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging]
|
|
374
|
-
|
|
375
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory#individuals
|
|
376
|
-
class Individuals < FinchAPI::Internal::Type::BaseModel
|
|
377
|
-
# @!attribute id
|
|
378
|
-
#
|
|
379
|
-
# @return [Boolean, nil]
|
|
380
|
-
optional :id, FinchAPI::Internal::Type::Boolean
|
|
381
|
-
|
|
382
|
-
# @!attribute department
|
|
383
|
-
#
|
|
384
|
-
# @return [Boolean, nil]
|
|
385
|
-
optional :department, FinchAPI::Internal::Type::Boolean
|
|
386
|
-
|
|
387
|
-
# @!attribute first_name
|
|
388
|
-
#
|
|
389
|
-
# @return [Boolean, nil]
|
|
390
|
-
optional :first_name, FinchAPI::Internal::Type::Boolean
|
|
391
|
-
|
|
392
|
-
# @!attribute is_active
|
|
393
|
-
#
|
|
394
|
-
# @return [Boolean, nil]
|
|
395
|
-
optional :is_active, FinchAPI::Internal::Type::Boolean
|
|
396
|
-
|
|
397
|
-
# @!attribute last_name
|
|
398
|
-
#
|
|
399
|
-
# @return [Boolean, nil]
|
|
400
|
-
optional :last_name, FinchAPI::Internal::Type::Boolean
|
|
401
|
-
|
|
402
|
-
# @!attribute manager
|
|
403
|
-
#
|
|
404
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, nil]
|
|
405
|
-
optional :manager,
|
|
406
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager }
|
|
407
|
-
|
|
408
|
-
# @!attribute middle_name
|
|
409
|
-
#
|
|
410
|
-
# @return [Boolean, nil]
|
|
411
|
-
optional :middle_name, FinchAPI::Internal::Type::Boolean
|
|
412
|
-
|
|
413
|
-
# @!method initialize(id: nil, department: nil, first_name: nil, is_active: nil, last_name: nil, manager: nil, middle_name: nil)
|
|
414
|
-
# @param id [Boolean]
|
|
415
|
-
# @param department [Boolean]
|
|
416
|
-
# @param first_name [Boolean]
|
|
417
|
-
# @param is_active [Boolean]
|
|
418
|
-
# @param last_name [Boolean]
|
|
419
|
-
# @param manager [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager]
|
|
420
|
-
# @param middle_name [Boolean]
|
|
421
|
-
|
|
422
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals#manager
|
|
423
|
-
class Manager < FinchAPI::Internal::Type::BaseModel
|
|
424
|
-
# @!attribute id
|
|
425
|
-
#
|
|
426
|
-
# @return [Boolean, nil]
|
|
427
|
-
optional :id, FinchAPI::Internal::Type::Boolean
|
|
428
|
-
|
|
429
|
-
# @!method initialize(id: nil)
|
|
430
|
-
# @param id [Boolean]
|
|
431
|
-
end
|
|
432
|
-
end
|
|
433
|
-
|
|
434
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory#paging
|
|
435
|
-
class Paging < FinchAPI::Internal::Type::BaseModel
|
|
436
|
-
# @!attribute count
|
|
437
|
-
#
|
|
438
|
-
# @return [Boolean, nil]
|
|
439
|
-
optional :count, FinchAPI::Internal::Type::Boolean
|
|
440
|
-
|
|
441
|
-
# @!attribute offset
|
|
442
|
-
#
|
|
443
|
-
# @return [Boolean, nil]
|
|
444
|
-
optional :offset, FinchAPI::Internal::Type::Boolean
|
|
445
|
-
|
|
446
|
-
# @!method initialize(count: nil, offset: nil)
|
|
447
|
-
# @param count [Boolean]
|
|
448
|
-
# @param offset [Boolean]
|
|
449
|
-
end
|
|
450
|
-
end
|
|
451
|
-
|
|
452
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#employment
|
|
453
|
-
class Employment < FinchAPI::Internal::Type::BaseModel
|
|
454
|
-
# @!attribute id
|
|
455
|
-
#
|
|
456
|
-
# @return [Boolean, nil]
|
|
457
|
-
optional :id, FinchAPI::Internal::Type::Boolean
|
|
458
|
-
|
|
459
|
-
# @!attribute class_code
|
|
460
|
-
#
|
|
461
|
-
# @return [Boolean, nil]
|
|
462
|
-
optional :class_code, FinchAPI::Internal::Type::Boolean
|
|
463
|
-
|
|
464
|
-
# @!attribute custom_fields
|
|
465
|
-
#
|
|
466
|
-
# @return [Boolean, nil]
|
|
467
|
-
optional :custom_fields, FinchAPI::Internal::Type::Boolean
|
|
468
|
-
|
|
469
|
-
# @!attribute department
|
|
470
|
-
#
|
|
471
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, nil]
|
|
472
|
-
optional :department,
|
|
473
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Department }
|
|
474
|
-
|
|
475
|
-
# @!attribute employment
|
|
476
|
-
#
|
|
477
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, nil]
|
|
478
|
-
optional :employment,
|
|
479
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Employment }
|
|
480
|
-
|
|
481
|
-
# @!attribute employment_status
|
|
482
|
-
#
|
|
483
|
-
# @return [Boolean, nil]
|
|
484
|
-
optional :employment_status, FinchAPI::Internal::Type::Boolean
|
|
485
|
-
|
|
486
|
-
# @!attribute end_date
|
|
487
|
-
#
|
|
488
|
-
# @return [Boolean, nil]
|
|
489
|
-
optional :end_date, FinchAPI::Internal::Type::Boolean
|
|
490
|
-
|
|
491
|
-
# @!attribute first_name
|
|
492
|
-
#
|
|
493
|
-
# @return [Boolean, nil]
|
|
494
|
-
optional :first_name, FinchAPI::Internal::Type::Boolean
|
|
495
|
-
|
|
496
|
-
# @!attribute income
|
|
497
|
-
#
|
|
498
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, nil]
|
|
499
|
-
optional :income, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Income }
|
|
500
|
-
|
|
501
|
-
# @!attribute income_history
|
|
502
|
-
#
|
|
503
|
-
# @return [Boolean, nil]
|
|
504
|
-
optional :income_history, FinchAPI::Internal::Type::Boolean
|
|
505
|
-
|
|
506
|
-
# @!attribute is_active
|
|
507
|
-
#
|
|
508
|
-
# @return [Boolean, nil]
|
|
509
|
-
optional :is_active, FinchAPI::Internal::Type::Boolean
|
|
510
|
-
|
|
511
|
-
# @!attribute last_name
|
|
512
|
-
#
|
|
513
|
-
# @return [Boolean, nil]
|
|
514
|
-
optional :last_name, FinchAPI::Internal::Type::Boolean
|
|
515
|
-
|
|
516
|
-
# @!attribute location
|
|
517
|
-
#
|
|
518
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, nil]
|
|
519
|
-
optional :location, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Location }
|
|
520
|
-
|
|
521
|
-
# @!attribute manager
|
|
522
|
-
#
|
|
523
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, nil]
|
|
524
|
-
optional :manager, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Employment::Manager }
|
|
525
|
-
|
|
526
|
-
# @!attribute middle_name
|
|
527
|
-
#
|
|
528
|
-
# @return [Boolean, nil]
|
|
529
|
-
optional :middle_name, FinchAPI::Internal::Type::Boolean
|
|
530
|
-
|
|
531
|
-
# @!attribute start_date
|
|
532
|
-
#
|
|
533
|
-
# @return [Boolean, nil]
|
|
534
|
-
optional :start_date, FinchAPI::Internal::Type::Boolean
|
|
535
|
-
|
|
536
|
-
# @!attribute title
|
|
537
|
-
#
|
|
538
|
-
# @return [Boolean, nil]
|
|
539
|
-
optional :title, FinchAPI::Internal::Type::Boolean
|
|
540
|
-
|
|
541
|
-
# @!method initialize(id: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, location: nil, manager: nil, middle_name: nil, start_date: nil, title: nil)
|
|
542
|
-
# @param id [Boolean]
|
|
543
|
-
# @param class_code [Boolean]
|
|
544
|
-
# @param custom_fields [Boolean]
|
|
545
|
-
# @param department [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department]
|
|
546
|
-
# @param employment [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment]
|
|
547
|
-
# @param employment_status [Boolean]
|
|
548
|
-
# @param end_date [Boolean]
|
|
549
|
-
# @param first_name [Boolean]
|
|
550
|
-
# @param income [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income]
|
|
551
|
-
# @param income_history [Boolean]
|
|
552
|
-
# @param is_active [Boolean]
|
|
553
|
-
# @param last_name [Boolean]
|
|
554
|
-
# @param location [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location]
|
|
555
|
-
# @param manager [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager]
|
|
556
|
-
# @param middle_name [Boolean]
|
|
557
|
-
# @param start_date [Boolean]
|
|
558
|
-
# @param title [Boolean]
|
|
559
|
-
|
|
560
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#department
|
|
561
|
-
class Department < FinchAPI::Internal::Type::BaseModel
|
|
562
|
-
# @!attribute name
|
|
563
|
-
#
|
|
564
|
-
# @return [Boolean, nil]
|
|
565
|
-
optional :name, FinchAPI::Internal::Type::Boolean
|
|
566
|
-
|
|
567
|
-
# @!method initialize(name: nil)
|
|
568
|
-
# @param name [Boolean]
|
|
569
|
-
end
|
|
570
|
-
|
|
571
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#employment
|
|
572
|
-
class Employment < FinchAPI::Internal::Type::BaseModel
|
|
573
|
-
# @!attribute subtype
|
|
574
|
-
#
|
|
575
|
-
# @return [Boolean, nil]
|
|
576
|
-
optional :subtype, FinchAPI::Internal::Type::Boolean
|
|
577
|
-
|
|
578
|
-
# @!attribute type
|
|
579
|
-
#
|
|
580
|
-
# @return [Boolean, nil]
|
|
581
|
-
optional :type, FinchAPI::Internal::Type::Boolean
|
|
582
|
-
|
|
583
|
-
# @!method initialize(subtype: nil, type: nil)
|
|
584
|
-
# @param subtype [Boolean]
|
|
585
|
-
# @param type [Boolean]
|
|
586
|
-
end
|
|
587
|
-
|
|
588
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#income
|
|
589
|
-
class Income < FinchAPI::Internal::Type::BaseModel
|
|
590
|
-
# @!attribute amount
|
|
591
|
-
#
|
|
592
|
-
# @return [Boolean, nil]
|
|
593
|
-
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
594
|
-
|
|
595
|
-
# @!attribute currency
|
|
596
|
-
#
|
|
597
|
-
# @return [Boolean, nil]
|
|
598
|
-
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
599
|
-
|
|
600
|
-
# @!attribute unit
|
|
601
|
-
#
|
|
602
|
-
# @return [Boolean, nil]
|
|
603
|
-
optional :unit, FinchAPI::Internal::Type::Boolean
|
|
604
|
-
|
|
605
|
-
# @!method initialize(amount: nil, currency: nil, unit: nil)
|
|
606
|
-
# @param amount [Boolean]
|
|
607
|
-
# @param currency [Boolean]
|
|
608
|
-
# @param unit [Boolean]
|
|
609
|
-
end
|
|
610
|
-
|
|
611
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#location
|
|
612
|
-
class Location < FinchAPI::Internal::Type::BaseModel
|
|
613
|
-
# @!attribute city
|
|
614
|
-
#
|
|
615
|
-
# @return [Boolean, nil]
|
|
616
|
-
optional :city, FinchAPI::Internal::Type::Boolean
|
|
617
|
-
|
|
618
|
-
# @!attribute country
|
|
619
|
-
#
|
|
620
|
-
# @return [Boolean, nil]
|
|
621
|
-
optional :country, FinchAPI::Internal::Type::Boolean
|
|
622
|
-
|
|
623
|
-
# @!attribute line1
|
|
624
|
-
#
|
|
625
|
-
# @return [Boolean, nil]
|
|
626
|
-
optional :line1, FinchAPI::Internal::Type::Boolean
|
|
627
|
-
|
|
628
|
-
# @!attribute line2
|
|
629
|
-
#
|
|
630
|
-
# @return [Boolean, nil]
|
|
631
|
-
optional :line2, FinchAPI::Internal::Type::Boolean
|
|
632
|
-
|
|
633
|
-
# @!attribute postal_code
|
|
634
|
-
#
|
|
635
|
-
# @return [Boolean, nil]
|
|
636
|
-
optional :postal_code, FinchAPI::Internal::Type::Boolean
|
|
637
|
-
|
|
638
|
-
# @!attribute state
|
|
639
|
-
#
|
|
640
|
-
# @return [Boolean, nil]
|
|
641
|
-
optional :state, FinchAPI::Internal::Type::Boolean
|
|
642
|
-
|
|
643
|
-
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
|
644
|
-
# @param city [Boolean]
|
|
645
|
-
# @param country [Boolean]
|
|
646
|
-
# @param line1 [Boolean]
|
|
647
|
-
# @param line2 [Boolean]
|
|
648
|
-
# @param postal_code [Boolean]
|
|
649
|
-
# @param state [Boolean]
|
|
650
|
-
end
|
|
651
|
-
|
|
652
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment#manager
|
|
653
|
-
class Manager < FinchAPI::Internal::Type::BaseModel
|
|
654
|
-
# @!attribute id
|
|
655
|
-
#
|
|
656
|
-
# @return [Boolean, nil]
|
|
657
|
-
optional :id, FinchAPI::Internal::Type::Boolean
|
|
658
|
-
|
|
659
|
-
# @!method initialize(id: nil)
|
|
660
|
-
# @param id [Boolean]
|
|
661
|
-
end
|
|
662
|
-
end
|
|
663
|
-
|
|
664
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#individual
|
|
665
|
-
class Individual < FinchAPI::Internal::Type::BaseModel
|
|
666
|
-
# @!attribute id
|
|
667
|
-
#
|
|
668
|
-
# @return [Boolean, nil]
|
|
669
|
-
optional :id, FinchAPI::Internal::Type::Boolean
|
|
670
|
-
|
|
671
|
-
# @!attribute dob
|
|
672
|
-
#
|
|
673
|
-
# @return [Boolean, nil]
|
|
674
|
-
optional :dob, FinchAPI::Internal::Type::Boolean
|
|
675
|
-
|
|
676
|
-
# @!attribute emails
|
|
677
|
-
#
|
|
678
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, nil]
|
|
679
|
-
optional :emails, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Emails }
|
|
680
|
-
|
|
681
|
-
# @!attribute encrypted_ssn
|
|
682
|
-
#
|
|
683
|
-
# @return [Boolean, nil]
|
|
684
|
-
optional :encrypted_ssn, FinchAPI::Internal::Type::Boolean
|
|
685
|
-
|
|
686
|
-
# @!attribute ethnicity
|
|
687
|
-
#
|
|
688
|
-
# @return [Boolean, nil]
|
|
689
|
-
optional :ethnicity, FinchAPI::Internal::Type::Boolean
|
|
690
|
-
|
|
691
|
-
# @!attribute first_name
|
|
692
|
-
#
|
|
693
|
-
# @return [Boolean, nil]
|
|
694
|
-
optional :first_name, FinchAPI::Internal::Type::Boolean
|
|
695
|
-
|
|
696
|
-
# @!attribute gender
|
|
697
|
-
#
|
|
698
|
-
# @return [Boolean, nil]
|
|
699
|
-
optional :gender, FinchAPI::Internal::Type::Boolean
|
|
700
|
-
|
|
701
|
-
# @!attribute last_name
|
|
702
|
-
#
|
|
703
|
-
# @return [Boolean, nil]
|
|
704
|
-
optional :last_name, FinchAPI::Internal::Type::Boolean
|
|
705
|
-
|
|
706
|
-
# @!attribute middle_name
|
|
707
|
-
#
|
|
708
|
-
# @return [Boolean, nil]
|
|
709
|
-
optional :middle_name, FinchAPI::Internal::Type::Boolean
|
|
710
|
-
|
|
711
|
-
# @!attribute phone_numbers
|
|
712
|
-
#
|
|
713
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, nil]
|
|
714
|
-
optional :phone_numbers,
|
|
715
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers }
|
|
716
|
-
|
|
717
|
-
# @!attribute preferred_name
|
|
718
|
-
#
|
|
719
|
-
# @return [Boolean, nil]
|
|
720
|
-
optional :preferred_name, FinchAPI::Internal::Type::Boolean
|
|
721
|
-
|
|
722
|
-
# @!attribute residence
|
|
723
|
-
#
|
|
724
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, nil]
|
|
725
|
-
optional :residence,
|
|
726
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Individual::Residence }
|
|
727
|
-
|
|
728
|
-
# @!attribute ssn
|
|
729
|
-
#
|
|
730
|
-
# @return [Boolean, nil]
|
|
731
|
-
optional :ssn, FinchAPI::Internal::Type::Boolean
|
|
732
|
-
|
|
733
|
-
# @!method initialize(id: nil, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil)
|
|
734
|
-
# @param id [Boolean]
|
|
735
|
-
# @param dob [Boolean]
|
|
736
|
-
# @param emails [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails]
|
|
737
|
-
# @param encrypted_ssn [Boolean]
|
|
738
|
-
# @param ethnicity [Boolean]
|
|
739
|
-
# @param first_name [Boolean]
|
|
740
|
-
# @param gender [Boolean]
|
|
741
|
-
# @param last_name [Boolean]
|
|
742
|
-
# @param middle_name [Boolean]
|
|
743
|
-
# @param phone_numbers [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers]
|
|
744
|
-
# @param preferred_name [Boolean]
|
|
745
|
-
# @param residence [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence]
|
|
746
|
-
# @param ssn [Boolean]
|
|
747
|
-
|
|
748
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#emails
|
|
749
|
-
class Emails < FinchAPI::Internal::Type::BaseModel
|
|
750
|
-
# @!attribute data
|
|
751
|
-
#
|
|
752
|
-
# @return [Boolean, nil]
|
|
753
|
-
optional :data, FinchAPI::Internal::Type::Boolean
|
|
754
|
-
|
|
755
|
-
# @!attribute type
|
|
756
|
-
#
|
|
757
|
-
# @return [Boolean, nil]
|
|
758
|
-
optional :type, FinchAPI::Internal::Type::Boolean
|
|
759
|
-
|
|
760
|
-
# @!method initialize(data: nil, type: nil)
|
|
761
|
-
# @param data [Boolean]
|
|
762
|
-
# @param type [Boolean]
|
|
763
|
-
end
|
|
764
|
-
|
|
765
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#phone_numbers
|
|
766
|
-
class PhoneNumbers < FinchAPI::Internal::Type::BaseModel
|
|
767
|
-
# @!attribute data
|
|
768
|
-
#
|
|
769
|
-
# @return [Boolean, nil]
|
|
770
|
-
optional :data, FinchAPI::Internal::Type::Boolean
|
|
771
|
-
|
|
772
|
-
# @!attribute type
|
|
773
|
-
#
|
|
774
|
-
# @return [Boolean, nil]
|
|
775
|
-
optional :type, FinchAPI::Internal::Type::Boolean
|
|
776
|
-
|
|
777
|
-
# @!method initialize(data: nil, type: nil)
|
|
778
|
-
# @param data [Boolean]
|
|
779
|
-
# @param type [Boolean]
|
|
780
|
-
end
|
|
781
|
-
|
|
782
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual#residence
|
|
783
|
-
class Residence < FinchAPI::Internal::Type::BaseModel
|
|
784
|
-
# @!attribute city
|
|
785
|
-
#
|
|
786
|
-
# @return [Boolean, nil]
|
|
787
|
-
optional :city, FinchAPI::Internal::Type::Boolean
|
|
788
|
-
|
|
789
|
-
# @!attribute country
|
|
790
|
-
#
|
|
791
|
-
# @return [Boolean, nil]
|
|
792
|
-
optional :country, FinchAPI::Internal::Type::Boolean
|
|
793
|
-
|
|
794
|
-
# @!attribute line1
|
|
795
|
-
#
|
|
796
|
-
# @return [Boolean, nil]
|
|
797
|
-
optional :line1, FinchAPI::Internal::Type::Boolean
|
|
798
|
-
|
|
799
|
-
# @!attribute line2
|
|
800
|
-
#
|
|
801
|
-
# @return [Boolean, nil]
|
|
802
|
-
optional :line2, FinchAPI::Internal::Type::Boolean
|
|
803
|
-
|
|
804
|
-
# @!attribute postal_code
|
|
805
|
-
#
|
|
806
|
-
# @return [Boolean, nil]
|
|
807
|
-
optional :postal_code, FinchAPI::Internal::Type::Boolean
|
|
808
|
-
|
|
809
|
-
# @!attribute state
|
|
810
|
-
#
|
|
811
|
-
# @return [Boolean, nil]
|
|
812
|
-
optional :state, FinchAPI::Internal::Type::Boolean
|
|
813
|
-
|
|
814
|
-
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
|
815
|
-
# @param city [Boolean]
|
|
816
|
-
# @param country [Boolean]
|
|
817
|
-
# @param line1 [Boolean]
|
|
818
|
-
# @param line2 [Boolean]
|
|
819
|
-
# @param postal_code [Boolean]
|
|
820
|
-
# @param state [Boolean]
|
|
821
|
-
end
|
|
822
|
-
end
|
|
823
|
-
|
|
824
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#pay_group
|
|
825
|
-
class PayGroup < FinchAPI::Internal::Type::BaseModel
|
|
826
|
-
# @!attribute id
|
|
827
|
-
#
|
|
828
|
-
# @return [Boolean, nil]
|
|
829
|
-
optional :id, FinchAPI::Internal::Type::Boolean
|
|
830
|
-
|
|
831
|
-
# @!attribute individual_ids
|
|
832
|
-
#
|
|
833
|
-
# @return [Boolean, nil]
|
|
834
|
-
optional :individual_ids, FinchAPI::Internal::Type::Boolean
|
|
835
|
-
|
|
836
|
-
# @!attribute name
|
|
837
|
-
#
|
|
838
|
-
# @return [Boolean, nil]
|
|
839
|
-
optional :name, FinchAPI::Internal::Type::Boolean
|
|
840
|
-
|
|
841
|
-
# @!attribute pay_frequencies
|
|
842
|
-
#
|
|
843
|
-
# @return [Boolean, nil]
|
|
844
|
-
optional :pay_frequencies, FinchAPI::Internal::Type::Boolean
|
|
845
|
-
|
|
846
|
-
# @!method initialize(id: nil, individual_ids: nil, name: nil, pay_frequencies: nil)
|
|
847
|
-
# @param id [Boolean]
|
|
848
|
-
# @param individual_ids [Boolean]
|
|
849
|
-
# @param name [Boolean]
|
|
850
|
-
# @param pay_frequencies [Boolean]
|
|
851
|
-
end
|
|
852
|
-
|
|
853
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#pay_statement
|
|
854
|
-
class PayStatement < FinchAPI::Internal::Type::BaseModel
|
|
855
|
-
# @!attribute paging
|
|
856
|
-
#
|
|
857
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, nil]
|
|
858
|
-
optional :paging, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging }
|
|
859
|
-
|
|
860
|
-
# @!attribute pay_statements
|
|
861
|
-
#
|
|
862
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, nil]
|
|
863
|
-
optional :pay_statements,
|
|
864
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements }
|
|
865
|
-
|
|
866
|
-
# @!method initialize(paging: nil, pay_statements: nil)
|
|
867
|
-
# @param paging [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging]
|
|
868
|
-
# @param pay_statements [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements]
|
|
869
|
-
|
|
870
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement#paging
|
|
871
|
-
class Paging < FinchAPI::Internal::Type::BaseModel
|
|
872
|
-
# @!attribute count
|
|
873
|
-
#
|
|
874
|
-
# @return [Boolean]
|
|
875
|
-
required :count, FinchAPI::Internal::Type::Boolean
|
|
876
|
-
|
|
877
|
-
# @!attribute offset
|
|
878
|
-
#
|
|
879
|
-
# @return [Boolean]
|
|
880
|
-
required :offset, FinchAPI::Internal::Type::Boolean
|
|
881
|
-
|
|
882
|
-
# @!method initialize(count:, offset:)
|
|
883
|
-
# @param count [Boolean]
|
|
884
|
-
# @param offset [Boolean]
|
|
885
|
-
end
|
|
886
|
-
|
|
887
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement#pay_statements
|
|
888
|
-
class PayStatements < FinchAPI::Internal::Type::BaseModel
|
|
889
|
-
# @!attribute earnings
|
|
890
|
-
#
|
|
891
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, nil]
|
|
892
|
-
optional :earnings,
|
|
893
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings }
|
|
894
|
-
|
|
895
|
-
# @!attribute employee_deductions
|
|
896
|
-
#
|
|
897
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, nil]
|
|
898
|
-
optional :employee_deductions,
|
|
899
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions }
|
|
900
|
-
|
|
901
|
-
# @!attribute employer_contributions
|
|
902
|
-
#
|
|
903
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, nil]
|
|
904
|
-
optional :employer_contributions,
|
|
905
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions }
|
|
906
|
-
|
|
907
|
-
# @!attribute gross_pay
|
|
908
|
-
#
|
|
909
|
-
# @return [Boolean, nil]
|
|
910
|
-
optional :gross_pay, FinchAPI::Internal::Type::Boolean
|
|
911
|
-
|
|
912
|
-
# @!attribute individual_id
|
|
913
|
-
#
|
|
914
|
-
# @return [Boolean, nil]
|
|
915
|
-
optional :individual_id, FinchAPI::Internal::Type::Boolean
|
|
916
|
-
|
|
917
|
-
# @!attribute net_pay
|
|
918
|
-
#
|
|
919
|
-
# @return [Boolean, nil]
|
|
920
|
-
optional :net_pay, FinchAPI::Internal::Type::Boolean
|
|
921
|
-
|
|
922
|
-
# @!attribute payment_method
|
|
923
|
-
#
|
|
924
|
-
# @return [Boolean, nil]
|
|
925
|
-
optional :payment_method, FinchAPI::Internal::Type::Boolean
|
|
926
|
-
|
|
927
|
-
# @!attribute taxes
|
|
928
|
-
#
|
|
929
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, nil]
|
|
930
|
-
optional :taxes,
|
|
931
|
-
-> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes }
|
|
932
|
-
|
|
933
|
-
# @!attribute total_hours
|
|
934
|
-
#
|
|
935
|
-
# @return [Boolean, nil]
|
|
936
|
-
optional :total_hours, FinchAPI::Internal::Type::Boolean
|
|
937
|
-
|
|
938
|
-
# @!attribute type
|
|
939
|
-
#
|
|
940
|
-
# @return [Boolean, nil]
|
|
941
|
-
optional :type, FinchAPI::Internal::Type::Boolean
|
|
942
|
-
|
|
943
|
-
# @!method initialize(earnings: nil, employee_deductions: nil, employer_contributions: nil, gross_pay: nil, individual_id: nil, net_pay: nil, payment_method: nil, taxes: nil, total_hours: nil, type: nil)
|
|
944
|
-
# @param earnings [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings]
|
|
945
|
-
# @param employee_deductions [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions]
|
|
946
|
-
# @param employer_contributions [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions]
|
|
947
|
-
# @param gross_pay [Boolean]
|
|
948
|
-
# @param individual_id [Boolean]
|
|
949
|
-
# @param net_pay [Boolean]
|
|
950
|
-
# @param payment_method [Boolean]
|
|
951
|
-
# @param taxes [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes]
|
|
952
|
-
# @param total_hours [Boolean]
|
|
953
|
-
# @param type [Boolean]
|
|
954
|
-
|
|
955
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#earnings
|
|
956
|
-
class Earnings < FinchAPI::Internal::Type::BaseModel
|
|
957
|
-
# @!attribute amount
|
|
958
|
-
#
|
|
959
|
-
# @return [Boolean, nil]
|
|
960
|
-
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
961
|
-
|
|
962
|
-
# @!attribute currency
|
|
963
|
-
#
|
|
964
|
-
# @return [Boolean, nil]
|
|
965
|
-
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
966
|
-
|
|
967
|
-
# @!attribute name
|
|
968
|
-
#
|
|
969
|
-
# @return [Boolean, nil]
|
|
970
|
-
optional :name, FinchAPI::Internal::Type::Boolean
|
|
971
|
-
|
|
972
|
-
# @!attribute type
|
|
973
|
-
#
|
|
974
|
-
# @return [Boolean, nil]
|
|
975
|
-
optional :type, FinchAPI::Internal::Type::Boolean
|
|
976
|
-
|
|
977
|
-
# @!method initialize(amount: nil, currency: nil, name: nil, type: nil)
|
|
978
|
-
# @param amount [Boolean]
|
|
979
|
-
# @param currency [Boolean]
|
|
980
|
-
# @param name [Boolean]
|
|
981
|
-
# @param type [Boolean]
|
|
982
|
-
end
|
|
983
|
-
|
|
984
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employee_deductions
|
|
985
|
-
class EmployeeDeductions < FinchAPI::Internal::Type::BaseModel
|
|
986
|
-
# @!attribute amount
|
|
987
|
-
#
|
|
988
|
-
# @return [Boolean, nil]
|
|
989
|
-
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
990
|
-
|
|
991
|
-
# @!attribute currency
|
|
992
|
-
#
|
|
993
|
-
# @return [Boolean, nil]
|
|
994
|
-
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
995
|
-
|
|
996
|
-
# @!attribute name
|
|
997
|
-
#
|
|
998
|
-
# @return [Boolean, nil]
|
|
999
|
-
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1000
|
-
|
|
1001
|
-
# @!attribute pre_tax
|
|
1002
|
-
#
|
|
1003
|
-
# @return [Boolean, nil]
|
|
1004
|
-
optional :pre_tax, FinchAPI::Internal::Type::Boolean
|
|
1005
|
-
|
|
1006
|
-
# @!attribute type
|
|
1007
|
-
#
|
|
1008
|
-
# @return [Boolean, nil]
|
|
1009
|
-
optional :type, FinchAPI::Internal::Type::Boolean
|
|
1010
|
-
|
|
1011
|
-
# @!method initialize(amount: nil, currency: nil, name: nil, pre_tax: nil, type: nil)
|
|
1012
|
-
# @param amount [Boolean]
|
|
1013
|
-
# @param currency [Boolean]
|
|
1014
|
-
# @param name [Boolean]
|
|
1015
|
-
# @param pre_tax [Boolean]
|
|
1016
|
-
# @param type [Boolean]
|
|
1017
|
-
end
|
|
1018
|
-
|
|
1019
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#employer_contributions
|
|
1020
|
-
class EmployerContributions < FinchAPI::Internal::Type::BaseModel
|
|
1021
|
-
# @!attribute amount
|
|
1022
|
-
#
|
|
1023
|
-
# @return [Boolean, nil]
|
|
1024
|
-
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1025
|
-
|
|
1026
|
-
# @!attribute currency
|
|
1027
|
-
#
|
|
1028
|
-
# @return [Boolean, nil]
|
|
1029
|
-
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1030
|
-
|
|
1031
|
-
# @!attribute name
|
|
1032
|
-
#
|
|
1033
|
-
# @return [Boolean, nil]
|
|
1034
|
-
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1035
|
-
|
|
1036
|
-
# @!method initialize(amount: nil, currency: nil, name: nil)
|
|
1037
|
-
# @param amount [Boolean]
|
|
1038
|
-
# @param currency [Boolean]
|
|
1039
|
-
# @param name [Boolean]
|
|
1040
|
-
end
|
|
1041
|
-
|
|
1042
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements#taxes
|
|
1043
|
-
class Taxes < FinchAPI::Internal::Type::BaseModel
|
|
1044
|
-
# @!attribute amount
|
|
1045
|
-
#
|
|
1046
|
-
# @return [Boolean, nil]
|
|
1047
|
-
optional :amount, FinchAPI::Internal::Type::Boolean
|
|
1048
|
-
|
|
1049
|
-
# @!attribute currency
|
|
1050
|
-
#
|
|
1051
|
-
# @return [Boolean, nil]
|
|
1052
|
-
optional :currency, FinchAPI::Internal::Type::Boolean
|
|
1053
|
-
|
|
1054
|
-
# @!attribute employer
|
|
1055
|
-
#
|
|
1056
|
-
# @return [Boolean, nil]
|
|
1057
|
-
optional :employer, FinchAPI::Internal::Type::Boolean
|
|
1058
|
-
|
|
1059
|
-
# @!attribute name
|
|
1060
|
-
#
|
|
1061
|
-
# @return [Boolean, nil]
|
|
1062
|
-
optional :name, FinchAPI::Internal::Type::Boolean
|
|
1063
|
-
|
|
1064
|
-
# @!attribute type
|
|
1065
|
-
#
|
|
1066
|
-
# @return [Boolean, nil]
|
|
1067
|
-
optional :type, FinchAPI::Internal::Type::Boolean
|
|
1068
|
-
|
|
1069
|
-
# @!method initialize(amount: nil, currency: nil, employer: nil, name: nil, type: nil)
|
|
1070
|
-
# @param amount [Boolean]
|
|
1071
|
-
# @param currency [Boolean]
|
|
1072
|
-
# @param employer [Boolean]
|
|
1073
|
-
# @param name [Boolean]
|
|
1074
|
-
# @param type [Boolean]
|
|
1075
|
-
end
|
|
1076
|
-
end
|
|
1077
|
-
end
|
|
1078
|
-
|
|
1079
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields#payment
|
|
1080
|
-
class Payment < FinchAPI::Internal::Type::BaseModel
|
|
1081
|
-
# @!attribute id
|
|
1082
|
-
#
|
|
1083
|
-
# @return [Boolean, nil]
|
|
1084
|
-
optional :id, FinchAPI::Internal::Type::Boolean
|
|
1085
|
-
|
|
1086
|
-
# @!attribute company_debit
|
|
1087
|
-
#
|
|
1088
|
-
# @return [Boolean, nil]
|
|
1089
|
-
optional :company_debit, FinchAPI::Internal::Type::Boolean
|
|
1090
|
-
|
|
1091
|
-
# @!attribute debit_date
|
|
1092
|
-
#
|
|
1093
|
-
# @return [Boolean, nil]
|
|
1094
|
-
optional :debit_date, FinchAPI::Internal::Type::Boolean
|
|
1095
|
-
|
|
1096
|
-
# @!attribute employee_taxes
|
|
1097
|
-
#
|
|
1098
|
-
# @return [Boolean, nil]
|
|
1099
|
-
optional :employee_taxes, FinchAPI::Internal::Type::Boolean
|
|
1100
|
-
|
|
1101
|
-
# @!attribute employer_taxes
|
|
1102
|
-
#
|
|
1103
|
-
# @return [Boolean, nil]
|
|
1104
|
-
optional :employer_taxes, FinchAPI::Internal::Type::Boolean
|
|
1105
|
-
|
|
1106
|
-
# @!attribute gross_pay
|
|
1107
|
-
#
|
|
1108
|
-
# @return [Boolean, nil]
|
|
1109
|
-
optional :gross_pay, FinchAPI::Internal::Type::Boolean
|
|
1110
|
-
|
|
1111
|
-
# @!attribute individual_ids
|
|
1112
|
-
#
|
|
1113
|
-
# @return [Boolean, nil]
|
|
1114
|
-
optional :individual_ids, FinchAPI::Internal::Type::Boolean
|
|
1115
|
-
|
|
1116
|
-
# @!attribute net_pay
|
|
1117
|
-
#
|
|
1118
|
-
# @return [Boolean, nil]
|
|
1119
|
-
optional :net_pay, FinchAPI::Internal::Type::Boolean
|
|
1120
|
-
|
|
1121
|
-
# @!attribute pay_date
|
|
1122
|
-
#
|
|
1123
|
-
# @return [Boolean, nil]
|
|
1124
|
-
optional :pay_date, FinchAPI::Internal::Type::Boolean
|
|
1125
|
-
|
|
1126
|
-
# @!attribute pay_frequencies
|
|
1127
|
-
#
|
|
1128
|
-
# @return [Boolean, nil]
|
|
1129
|
-
optional :pay_frequencies, FinchAPI::Internal::Type::Boolean
|
|
1130
|
-
|
|
1131
|
-
# @!attribute pay_group_ids
|
|
1132
|
-
#
|
|
1133
|
-
# @return [Boolean, nil]
|
|
1134
|
-
optional :pay_group_ids, FinchAPI::Internal::Type::Boolean
|
|
1135
|
-
|
|
1136
|
-
# @!attribute pay_period
|
|
1137
|
-
#
|
|
1138
|
-
# @return [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, nil]
|
|
1139
|
-
optional :pay_period, -> { FinchAPI::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod }
|
|
1140
|
-
|
|
1141
|
-
# @!method initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil)
|
|
1142
|
-
# @param id [Boolean]
|
|
1143
|
-
# @param company_debit [Boolean]
|
|
1144
|
-
# @param debit_date [Boolean]
|
|
1145
|
-
# @param employee_taxes [Boolean]
|
|
1146
|
-
# @param employer_taxes [Boolean]
|
|
1147
|
-
# @param gross_pay [Boolean]
|
|
1148
|
-
# @param individual_ids [Boolean]
|
|
1149
|
-
# @param net_pay [Boolean]
|
|
1150
|
-
# @param pay_date [Boolean]
|
|
1151
|
-
# @param pay_frequencies [Boolean]
|
|
1152
|
-
# @param pay_group_ids [Boolean]
|
|
1153
|
-
# @param pay_period [FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod]
|
|
1154
|
-
|
|
1155
|
-
# @see FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment#pay_period
|
|
1156
|
-
class PayPeriod < FinchAPI::Internal::Type::BaseModel
|
|
1157
|
-
# @!attribute end_date
|
|
1158
|
-
#
|
|
1159
|
-
# @return [Boolean, nil]
|
|
1160
|
-
optional :end_date, FinchAPI::Internal::Type::Boolean
|
|
1161
|
-
|
|
1162
|
-
# @!attribute start_date
|
|
1163
|
-
#
|
|
1164
|
-
# @return [Boolean, nil]
|
|
1165
|
-
optional :start_date, FinchAPI::Internal::Type::Boolean
|
|
1166
|
-
|
|
1167
|
-
# @!method initialize(end_date: nil, start_date: nil)
|
|
1168
|
-
# @param end_date [Boolean]
|
|
1169
|
-
# @param start_date [Boolean]
|
|
1170
|
-
end
|
|
1171
|
-
end
|
|
1172
|
-
end
|
|
121
|
+
# @param supported_fields [Hash{Symbol=>Object, nil}] The supported fields for each Finch product
|
|
1173
122
|
|
|
1174
|
-
# The type of authentication method
|
|
123
|
+
# The type of authentication method
|
|
1175
124
|
#
|
|
1176
125
|
# @see FinchAPI::Models::Provider::AuthenticationMethod#type
|
|
1177
126
|
module Type
|
|
@@ -1182,6 +131,7 @@ module FinchAPI
|
|
|
1182
131
|
API_TOKEN = :api_token
|
|
1183
132
|
API_CREDENTIAL = :api_credential
|
|
1184
133
|
OAUTH = :oauth
|
|
134
|
+
API = :api
|
|
1185
135
|
|
|
1186
136
|
# @!method self.values
|
|
1187
137
|
# @return [Array<Symbol>]
|