finch-api 0.1.0.pre.alpha.41 → 0.1.0.pre.alpha.43
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 +73 -0
- data/README.md +3 -3
- data/lib/finch_api/client.rb +22 -4
- data/lib/finch_api/internal/transport/base_client.rb +30 -3
- data/lib/finch_api/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/finch_api/internal/util.rb +54 -8
- data/lib/finch_api/models/account_disconnect_entity_params.rb +22 -0
- data/lib/finch_api/models/base_webhook_event.rb +9 -1
- data/lib/finch_api/models/connect/session_new_params.rb +5 -3
- data/lib/finch_api/models/connect/session_reauthenticate_params.rb +5 -3
- data/lib/finch_api/models/create_access_token_response.rb +10 -1
- data/lib/finch_api/models/disconnect_entity_response.rb +17 -0
- data/lib/finch_api/models/hris/benefit_contribution.rb +24 -23
- data/lib/finch_api/models/hris/benefit_register_params.rb +47 -0
- data/lib/finch_api/models/hris/benefit_retrieve_params.rb +8 -1
- data/lib/finch_api/models/hris/benefit_update_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_benefit.rb +63 -59
- data/lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb +8 -1
- data/lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb +8 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rb +8 -1
- data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_params.rb +8 -1
- data/lib/finch_api/models/hris/document_retreive_params.rb +8 -1
- data/lib/finch_api/models/hris/employment_data.rb +76 -37
- data/lib/finch_api/models/hris/employment_data_response.rb +2 -2
- data/lib/finch_api/models/hris/individual.rb +38 -28
- data/lib/finch_api/models/hris/individual_response.rb +2 -2
- data/lib/finch_api/models/hris/register_company_benefit_response.rb +26 -0
- data/lib/finch_api/models/introspection.rb +27 -1
- data/lib/finch_api/models/job_completion_event.rb +3 -0
- data/lib/finch_api/models/jobs/automated_create_params.rb +53 -29
- data/lib/finch_api/models/jobs/automated_retrieve_params.rb +7 -1
- data/lib/finch_api/models/jobs/manual_retrieve_params.rb +7 -1
- data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb +8 -1
- data/lib/finch_api/models/sandbox/directory_create_params.rb +55 -4
- data/lib/finch_api/models/sandbox/employment_update_params.rb +58 -4
- data/lib/finch_api/models/sandbox/employment_update_response.rb +53 -4
- data/lib/finch_api/models/sandbox/individual_update_params.rb +8 -1
- data/lib/finch_api/models.rb +4 -0
- data/lib/finch_api/resources/access_tokens.rb +1 -0
- data/lib/finch_api/resources/account.rb +26 -0
- data/lib/finch_api/resources/connect/sessions.rb +4 -2
- data/lib/finch_api/resources/hris/benefits/individuals.rb +13 -5
- data/lib/finch_api/resources/hris/benefits.rb +50 -7
- data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +14 -6
- data/lib/finch_api/resources/hris/company/pay_statement_item.rb +3 -1
- data/lib/finch_api/resources/hris/company.rb +3 -1
- data/lib/finch_api/resources/hris/directory.rb +3 -1
- data/lib/finch_api/resources/hris/documents.rb +6 -2
- data/lib/finch_api/resources/hris/employments.rb +4 -2
- data/lib/finch_api/resources/hris/individuals.rb +4 -2
- data/lib/finch_api/resources/hris/pay_statements.rb +4 -2
- data/lib/finch_api/resources/hris/payments.rb +3 -1
- data/lib/finch_api/resources/jobs/automated.rb +8 -7
- data/lib/finch_api/resources/jobs/manual.rb +1 -0
- data/lib/finch_api/resources/payroll/pay_groups.rb +6 -2
- data/lib/finch_api/resources/providers.rb +1 -0
- data/lib/finch_api/resources/request_forwarding.rb +1 -0
- data/lib/finch_api/resources/sandbox/company.rb +1 -0
- data/lib/finch_api/resources/sandbox/connections/accounts.rb +2 -0
- data/lib/finch_api/resources/sandbox/connections.rb +1 -0
- data/lib/finch_api/resources/sandbox/directory.rb +1 -0
- data/lib/finch_api/resources/sandbox/employment.rb +4 -1
- data/lib/finch_api/resources/sandbox/individual.rb +1 -0
- data/lib/finch_api/resources/sandbox/jobs/configuration.rb +2 -0
- data/lib/finch_api/resources/sandbox/jobs.rb +1 -0
- data/lib/finch_api/resources/sandbox/payment.rb +1 -0
- data/lib/finch_api/version.rb +1 -1
- data/lib/finch_api.rb +4 -0
- data/rbi/finch_api/client.rbi +12 -2
- data/rbi/finch_api/internal/transport/base_client.rbi +6 -1
- data/rbi/finch_api/internal/util.rbi +29 -1
- data/rbi/finch_api/models/account_disconnect_entity_params.rbi +46 -0
- data/rbi/finch_api/models/base_webhook_event.rbi +18 -3
- data/rbi/finch_api/models/connect/session_new_params.rbi +11 -3
- data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi +11 -3
- data/rbi/finch_api/models/create_access_token_response.rbi +13 -3
- data/rbi/finch_api/models/disconnect_entity_response.rbi +27 -0
- data/rbi/finch_api/models/hris/benefit_contribution.rbi +33 -31
- data/rbi/finch_api/models/hris/benefit_register_params.rbi +76 -0
- data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefit_update_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_benefit.rbi +71 -71
- data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +6 -0
- data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi +6 -0
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbi +6 -0
- data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbi +6 -0
- data/rbi/finch_api/models/hris/document_retreive_params.rbi +6 -0
- data/rbi/finch_api/models/hris/employment_data.rbi +121 -56
- data/rbi/finch_api/models/hris/employment_data_response.rbi +1 -1
- data/rbi/finch_api/models/hris/individual.rbi +54 -47
- data/rbi/finch_api/models/hris/individual_response.rbi +1 -1
- data/rbi/finch_api/models/hris/register_company_benefit_response.rbi +38 -0
- data/rbi/finch_api/models/introspection.rbi +66 -3
- data/rbi/finch_api/models/job_completion_event.rbi +15 -0
- data/rbi/finch_api/models/jobs/automated_create_params.rbi +126 -56
- data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi +13 -5
- data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi +13 -5
- data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi +6 -0
- data/rbi/finch_api/models/sandbox/directory_create_params.rbi +122 -9
- data/rbi/finch_api/models/sandbox/employment_update_params.rbi +128 -9
- data/rbi/finch_api/models/sandbox/employment_update_response.rbi +122 -9
- data/rbi/finch_api/models/sandbox/individual_update_params.rbi +6 -0
- data/rbi/finch_api/models.rbi +5 -0
- data/rbi/finch_api/resources/account.rbi +15 -0
- data/rbi/finch_api/resources/connect/sessions.rbi +6 -2
- data/rbi/finch_api/resources/hris/benefits.rbi +24 -0
- data/rbi/finch_api/resources/jobs/automated.rbi +6 -8
- data/rbi/finch_api/resources/sandbox/employment.rbi +7 -0
- data/sig/finch_api/client.rbs +6 -1
- data/sig/finch_api/internal/transport/base_client.rbs +2 -0
- data/sig/finch_api/internal/util.rbs +14 -0
- data/sig/finch_api/models/account_disconnect_entity_params.rbs +24 -0
- data/sig/finch_api/models/base_webhook_event.rbs +14 -3
- data/sig/finch_api/models/connect/session_new_params.rbs +2 -0
- data/sig/finch_api/models/connect/session_reauthenticate_params.rbs +2 -0
- data/sig/finch_api/models/create_access_token_response.rbs +8 -3
- data/sig/finch_api/models/disconnect_entity_response.rbs +13 -0
- data/sig/finch_api/models/hris/benefit_contribution.rbs +28 -28
- data/sig/finch_api/models/hris/benefit_register_params.rbs +47 -0
- data/sig/finch_api/models/hris/benefit_retrieve_params.rbs +5 -1
- data/sig/finch_api/models/hris/benefit_update_params.rbs +5 -1
- data/sig/finch_api/models/hris/benefits/individual_benefit.rbs +62 -62
- data/sig/finch_api/models/hris/benefits/individual_enroll_many_params.rbs +5 -0
- data/sig/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbs +5 -1
- data/sig/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +9 -1
- data/sig/finch_api/models/hris/benefits/individual_unenroll_many_params.rbs +9 -1
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_delete_params.rbs +5 -1
- data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs +9 -1
- data/sig/finch_api/models/hris/document_retreive_params.rbs +5 -1
- data/sig/finch_api/models/hris/employment_data.rbs +56 -39
- data/sig/finch_api/models/hris/individual.rbs +31 -31
- data/sig/finch_api/models/hris/register_company_benefit_response.rbs +18 -0
- data/sig/finch_api/models/introspection.rbs +44 -3
- data/sig/finch_api/models/job_completion_event.rbs +6 -0
- data/sig/finch_api/models/jobs/automated_create_params.rbs +47 -22
- data/sig/finch_api/models/jobs/automated_retrieve_params.rbs +11 -3
- data/sig/finch_api/models/jobs/manual_retrieve_params.rbs +11 -3
- data/sig/finch_api/models/payroll/pay_group_retrieve_params.rbs +5 -1
- data/sig/finch_api/models/sandbox/directory_create_params.rbs +40 -5
- data/sig/finch_api/models/sandbox/employment_update_params.rbs +45 -5
- data/sig/finch_api/models/sandbox/employment_update_response.rbs +40 -5
- data/sig/finch_api/models/sandbox/individual_update_params.rbs +5 -0
- data/sig/finch_api/models.rbs +4 -0
- data/sig/finch_api/resources/account.rbs +5 -0
- data/sig/finch_api/resources/hris/benefits.rbs +8 -0
- data/sig/finch_api/resources/jobs/automated.rbs +1 -2
- data/sig/finch_api/resources/sandbox/employment.rbs +1 -0
- metadata +14 -2
|
@@ -9,6 +9,11 @@ module FinchAPI
|
|
|
9
9
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include FinchAPI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute benefit_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :benefit_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute entity_ids
|
|
13
18
|
# The entity IDs to specify which entities' data to access.
|
|
14
19
|
#
|
|
@@ -22,11 +27,13 @@ module FinchAPI
|
|
|
22
27
|
# @return [String, nil]
|
|
23
28
|
optional :individual_ids, String
|
|
24
29
|
|
|
25
|
-
# @!method initialize(entity_ids: nil, individual_ids: nil, request_options: {})
|
|
30
|
+
# @!method initialize(benefit_id:, entity_ids: nil, individual_ids: nil, request_options: {})
|
|
26
31
|
# Some parameter documentations has been truncated, see
|
|
27
32
|
# {FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams} for
|
|
28
33
|
# more details.
|
|
29
34
|
#
|
|
35
|
+
# @param benefit_id [String]
|
|
36
|
+
#
|
|
30
37
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
31
38
|
#
|
|
32
39
|
# @param individual_ids [String] comma-delimited list of stable Finch uuids for each individual. If empty, defaul
|
|
@@ -9,6 +9,11 @@ module FinchAPI
|
|
|
9
9
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include FinchAPI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute benefit_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :benefit_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute entity_ids
|
|
13
18
|
# The entity IDs to specify which entities' data to access.
|
|
14
19
|
#
|
|
@@ -21,7 +26,9 @@ module FinchAPI
|
|
|
21
26
|
# @return [Array<String>, nil]
|
|
22
27
|
optional :individual_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
23
28
|
|
|
24
|
-
# @!method initialize(entity_ids: nil, individual_ids: nil, request_options: {})
|
|
29
|
+
# @!method initialize(benefit_id:, entity_ids: nil, individual_ids: nil, request_options: {})
|
|
30
|
+
# @param benefit_id [String]
|
|
31
|
+
#
|
|
25
32
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
26
33
|
#
|
|
27
34
|
# @param individual_ids [Array<String>] Array of individual_ids to unenroll.
|
|
@@ -10,13 +10,20 @@ module FinchAPI
|
|
|
10
10
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
11
11
|
include FinchAPI::Internal::Type::RequestParameters
|
|
12
12
|
|
|
13
|
+
# @!attribute rule_id
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :rule_id, String
|
|
17
|
+
|
|
13
18
|
# @!attribute entity_ids
|
|
14
19
|
# The entity IDs to delete the rule for.
|
|
15
20
|
#
|
|
16
21
|
# @return [Array<String>, nil]
|
|
17
22
|
optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
18
23
|
|
|
19
|
-
# @!method initialize(entity_ids: nil, request_options: {})
|
|
24
|
+
# @!method initialize(rule_id:, entity_ids: nil, request_options: {})
|
|
25
|
+
# @param rule_id [String]
|
|
26
|
+
#
|
|
20
27
|
# @param entity_ids [Array<String>] The entity IDs to delete the rule for.
|
|
21
28
|
#
|
|
22
29
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -10,6 +10,11 @@ module FinchAPI
|
|
|
10
10
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
11
11
|
include FinchAPI::Internal::Type::RequestParameters
|
|
12
12
|
|
|
13
|
+
# @!attribute rule_id
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :rule_id, String
|
|
17
|
+
|
|
13
18
|
# @!attribute entity_ids
|
|
14
19
|
# The entity IDs to update the rule for.
|
|
15
20
|
#
|
|
@@ -21,7 +26,9 @@ module FinchAPI
|
|
|
21
26
|
# @return [Object, nil]
|
|
22
27
|
optional :optional_property, FinchAPI::Internal::Type::Unknown, api_name: :optionalProperty
|
|
23
28
|
|
|
24
|
-
# @!method initialize(entity_ids: nil, optional_property: nil, request_options: {})
|
|
29
|
+
# @!method initialize(rule_id:, entity_ids: nil, optional_property: nil, request_options: {})
|
|
30
|
+
# @param rule_id [String]
|
|
31
|
+
#
|
|
25
32
|
# @param entity_ids [Array<String>] The entity IDs to update the rule for.
|
|
26
33
|
#
|
|
27
34
|
# @param optional_property [Object]
|
|
@@ -8,13 +8,20 @@ module FinchAPI
|
|
|
8
8
|
extend FinchAPI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include FinchAPI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute document_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :document_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute entity_ids
|
|
12
17
|
# The entity IDs to specify which entities' data to access.
|
|
13
18
|
#
|
|
14
19
|
# @return [Array<String>, nil]
|
|
15
20
|
optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
|
|
16
21
|
|
|
17
|
-
# @!method initialize(entity_ids: nil, request_options: {})
|
|
22
|
+
# @!method initialize(document_id:, entity_ids: nil, request_options: {})
|
|
23
|
+
# @param document_id [String]
|
|
24
|
+
#
|
|
18
25
|
# @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
|
|
19
26
|
#
|
|
20
27
|
# @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -6,11 +6,11 @@ module FinchAPI
|
|
|
6
6
|
module EmploymentData
|
|
7
7
|
extend FinchAPI::Internal::Type::Union
|
|
8
8
|
|
|
9
|
-
variant -> { FinchAPI::HRIS::EmploymentData::
|
|
9
|
+
variant -> { FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody }
|
|
10
10
|
|
|
11
11
|
variant -> { FinchAPI::HRIS::EmploymentData::BatchError }
|
|
12
12
|
|
|
13
|
-
class
|
|
13
|
+
class EmploymentDataResponseBody < FinchAPI::Internal::Type::BaseModel
|
|
14
14
|
# @!attribute id
|
|
15
15
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
|
16
16
|
#
|
|
@@ -26,21 +26,25 @@ module FinchAPI
|
|
|
26
26
|
# @!attribute department
|
|
27
27
|
# The department object.
|
|
28
28
|
#
|
|
29
|
-
# @return [FinchAPI::Models::HRIS::EmploymentData::
|
|
30
|
-
required :department,
|
|
29
|
+
# @return [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Department, nil]
|
|
30
|
+
required :department,
|
|
31
|
+
-> { FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::Department },
|
|
32
|
+
nil?: true
|
|
31
33
|
|
|
32
34
|
# @!attribute employment
|
|
33
35
|
# The employment object.
|
|
34
36
|
#
|
|
35
|
-
# @return [FinchAPI::Models::HRIS::EmploymentData::
|
|
36
|
-
required :employment,
|
|
37
|
+
# @return [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Employment, nil]
|
|
38
|
+
required :employment,
|
|
39
|
+
-> { FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::Employment },
|
|
40
|
+
nil?: true
|
|
37
41
|
|
|
38
42
|
# @!attribute employment_status
|
|
39
43
|
# The detailed employment status of the individual.
|
|
40
44
|
#
|
|
41
|
-
# @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::
|
|
45
|
+
# @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::EmploymentStatus, nil]
|
|
42
46
|
required :employment_status,
|
|
43
|
-
enum: -> { FinchAPI::HRIS::EmploymentData::
|
|
47
|
+
enum: -> { FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::EmploymentStatus },
|
|
44
48
|
nil?: true
|
|
45
49
|
|
|
46
50
|
# @!attribute end_date
|
|
@@ -54,6 +58,15 @@ module FinchAPI
|
|
|
54
58
|
# @return [String, nil]
|
|
55
59
|
required :first_name, String, nil?: true
|
|
56
60
|
|
|
61
|
+
# @!attribute flsa_status
|
|
62
|
+
# The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
|
|
63
|
+
# `unknown`.
|
|
64
|
+
#
|
|
65
|
+
# @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::FlsaStatus, nil]
|
|
66
|
+
required :flsa_status,
|
|
67
|
+
enum: -> { FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::FlsaStatus },
|
|
68
|
+
nil?: true
|
|
69
|
+
|
|
57
70
|
# @!attribute is_active
|
|
58
71
|
# `true` if the individual an an active employee or contractor at the company.
|
|
59
72
|
#
|
|
@@ -79,8 +92,12 @@ module FinchAPI
|
|
|
79
92
|
# @!attribute manager
|
|
80
93
|
# The manager object representing the manager of the individual within the org.
|
|
81
94
|
#
|
|
82
|
-
# @return [FinchAPI::Models::HRIS::EmploymentData::
|
|
83
|
-
required :manager,
|
|
95
|
+
# @return [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Manager, nil]
|
|
96
|
+
required :manager,
|
|
97
|
+
-> {
|
|
98
|
+
FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::Manager
|
|
99
|
+
},
|
|
100
|
+
nil?: true
|
|
84
101
|
|
|
85
102
|
# @!attribute middle_name
|
|
86
103
|
# The legal middle name of the individual.
|
|
@@ -104,10 +121,10 @@ module FinchAPI
|
|
|
104
121
|
# employer in the system. Custom fields are not currently supported for assisted
|
|
105
122
|
# connections.
|
|
106
123
|
#
|
|
107
|
-
# @return [Array<FinchAPI::Models::HRIS::EmploymentData::
|
|
124
|
+
# @return [Array<FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField>, nil]
|
|
108
125
|
optional :custom_fields,
|
|
109
126
|
-> {
|
|
110
|
-
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentData::
|
|
127
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField]
|
|
111
128
|
},
|
|
112
129
|
nil?: true
|
|
113
130
|
|
|
@@ -141,24 +158,27 @@ module FinchAPI
|
|
|
141
158
|
# @return [String, nil]
|
|
142
159
|
optional :work_id, String, nil?: true
|
|
143
160
|
|
|
144
|
-
# @!method initialize(id:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, is_active:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
|
|
161
|
+
# @!method initialize(id:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, flsa_status:, is_active:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
|
|
145
162
|
# Some parameter documentations has been truncated, see
|
|
146
|
-
# {FinchAPI::Models::HRIS::EmploymentData::
|
|
163
|
+
# {FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody} for more
|
|
164
|
+
# details.
|
|
147
165
|
#
|
|
148
166
|
# @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
|
|
149
167
|
#
|
|
150
168
|
# @param class_code [String, nil] Worker's compensation classification code for this employee
|
|
151
169
|
#
|
|
152
|
-
# @param department [FinchAPI::Models::HRIS::EmploymentData::
|
|
170
|
+
# @param department [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Department, nil] The department object.
|
|
153
171
|
#
|
|
154
|
-
# @param employment [FinchAPI::Models::HRIS::EmploymentData::
|
|
172
|
+
# @param employment [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Employment, nil] The employment object.
|
|
155
173
|
#
|
|
156
|
-
# @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::
|
|
174
|
+
# @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::EmploymentStatus, nil] The detailed employment status of the individual.
|
|
157
175
|
#
|
|
158
176
|
# @param end_date [String, nil]
|
|
159
177
|
#
|
|
160
178
|
# @param first_name [String, nil] The legal first name of the individual.
|
|
161
179
|
#
|
|
180
|
+
# @param flsa_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::FlsaStatus, nil] The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `u
|
|
181
|
+
#
|
|
162
182
|
# @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
|
|
163
183
|
#
|
|
164
184
|
# @param last_name [String, nil] The legal last name of the individual.
|
|
@@ -167,7 +187,7 @@ module FinchAPI
|
|
|
167
187
|
#
|
|
168
188
|
# @param location [FinchAPI::Models::Location, nil]
|
|
169
189
|
#
|
|
170
|
-
# @param manager [FinchAPI::Models::HRIS::EmploymentData::
|
|
190
|
+
# @param manager [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Manager, nil] The manager object representing the manager of the individual within the org.
|
|
171
191
|
#
|
|
172
192
|
# @param middle_name [String, nil] The legal middle name of the individual.
|
|
173
193
|
#
|
|
@@ -175,7 +195,7 @@ module FinchAPI
|
|
|
175
195
|
#
|
|
176
196
|
# @param title [String, nil] The current title of the individual.
|
|
177
197
|
#
|
|
178
|
-
# @param custom_fields [Array<FinchAPI::Models::HRIS::EmploymentData::
|
|
198
|
+
# @param custom_fields [Array<FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
|
|
179
199
|
#
|
|
180
200
|
# @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
|
|
181
201
|
#
|
|
@@ -185,7 +205,7 @@ module FinchAPI
|
|
|
185
205
|
#
|
|
186
206
|
# @param work_id [String, nil] This field is deprecated in favour of `source_id`
|
|
187
207
|
|
|
188
|
-
# @see FinchAPI::Models::HRIS::EmploymentData::
|
|
208
|
+
# @see FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody#department
|
|
189
209
|
class Department < FinchAPI::Internal::Type::BaseModel
|
|
190
210
|
# @!attribute name
|
|
191
211
|
# The name of the department associated with the individual.
|
|
@@ -199,42 +219,44 @@ module FinchAPI
|
|
|
199
219
|
# @param name [String, nil] The name of the department associated with the individual.
|
|
200
220
|
end
|
|
201
221
|
|
|
202
|
-
# @see FinchAPI::Models::HRIS::EmploymentData::
|
|
222
|
+
# @see FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody#employment
|
|
203
223
|
class Employment < FinchAPI::Internal::Type::BaseModel
|
|
204
224
|
# @!attribute subtype
|
|
205
225
|
# The secondary employment type of the individual. Options: `full_time`,
|
|
206
226
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
|
207
227
|
#
|
|
208
|
-
# @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::
|
|
228
|
+
# @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Employment::Subtype, nil]
|
|
209
229
|
required :subtype,
|
|
210
|
-
enum: -> {
|
|
230
|
+
enum: -> {
|
|
231
|
+
FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::Employment::Subtype
|
|
232
|
+
},
|
|
211
233
|
nil?: true
|
|
212
234
|
|
|
213
235
|
# @!attribute type
|
|
214
236
|
# The main employment type of the individual.
|
|
215
237
|
#
|
|
216
|
-
# @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::
|
|
238
|
+
# @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Employment::Type, nil]
|
|
217
239
|
required :type,
|
|
218
240
|
enum: -> {
|
|
219
|
-
FinchAPI::HRIS::EmploymentData::
|
|
241
|
+
FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::Employment::Type
|
|
220
242
|
},
|
|
221
243
|
nil?: true
|
|
222
244
|
|
|
223
245
|
# @!method initialize(subtype:, type:)
|
|
224
246
|
# Some parameter documentations has been truncated, see
|
|
225
|
-
# {FinchAPI::Models::HRIS::EmploymentData::
|
|
226
|
-
# details.
|
|
247
|
+
# {FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Employment}
|
|
248
|
+
# for more details.
|
|
227
249
|
#
|
|
228
250
|
# The employment object.
|
|
229
251
|
#
|
|
230
|
-
# @param subtype [Symbol, FinchAPI::Models::HRIS::EmploymentData::
|
|
252
|
+
# @param subtype [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
|
|
231
253
|
#
|
|
232
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::EmploymentData::
|
|
254
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Employment::Type, nil] The main employment type of the individual.
|
|
233
255
|
|
|
234
256
|
# The secondary employment type of the individual. Options: `full_time`,
|
|
235
257
|
# `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
|
|
236
258
|
#
|
|
237
|
-
# @see FinchAPI::Models::HRIS::EmploymentData::
|
|
259
|
+
# @see FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Employment#subtype
|
|
238
260
|
module Subtype
|
|
239
261
|
extend FinchAPI::Internal::Type::Enum
|
|
240
262
|
|
|
@@ -251,7 +273,7 @@ module FinchAPI
|
|
|
251
273
|
|
|
252
274
|
# The main employment type of the individual.
|
|
253
275
|
#
|
|
254
|
-
# @see FinchAPI::Models::HRIS::EmploymentData::
|
|
276
|
+
# @see FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Employment#type
|
|
255
277
|
module Type
|
|
256
278
|
extend FinchAPI::Internal::Type::Enum
|
|
257
279
|
|
|
@@ -265,7 +287,7 @@ module FinchAPI
|
|
|
265
287
|
|
|
266
288
|
# The detailed employment status of the individual.
|
|
267
289
|
#
|
|
268
|
-
# @see FinchAPI::Models::HRIS::EmploymentData::
|
|
290
|
+
# @see FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody#employment_status
|
|
269
291
|
module EmploymentStatus
|
|
270
292
|
extend FinchAPI::Internal::Type::Enum
|
|
271
293
|
|
|
@@ -281,7 +303,22 @@ module FinchAPI
|
|
|
281
303
|
# @return [Array<Symbol>]
|
|
282
304
|
end
|
|
283
305
|
|
|
284
|
-
#
|
|
306
|
+
# The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
|
|
307
|
+
# `unknown`.
|
|
308
|
+
#
|
|
309
|
+
# @see FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody#flsa_status
|
|
310
|
+
module FlsaStatus
|
|
311
|
+
extend FinchAPI::Internal::Type::Enum
|
|
312
|
+
|
|
313
|
+
EXEMPT = :exempt
|
|
314
|
+
NON_EXEMPT = :non_exempt
|
|
315
|
+
UNKNOWN = :unknown
|
|
316
|
+
|
|
317
|
+
# @!method self.values
|
|
318
|
+
# @return [Array<Symbol>]
|
|
319
|
+
end
|
|
320
|
+
|
|
321
|
+
# @see FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody#manager
|
|
285
322
|
class Manager < FinchAPI::Internal::Type::BaseModel
|
|
286
323
|
# @!attribute id
|
|
287
324
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
|
@@ -305,20 +342,22 @@ module FinchAPI
|
|
|
305
342
|
#
|
|
306
343
|
# @return [String, Array<Object>, Object, Float, Boolean, nil]
|
|
307
344
|
optional :value,
|
|
308
|
-
union: -> {
|
|
345
|
+
union: -> {
|
|
346
|
+
FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField::Value
|
|
347
|
+
},
|
|
309
348
|
nil?: true
|
|
310
349
|
|
|
311
350
|
# @!method initialize(name: nil, value: nil)
|
|
312
351
|
# @param name [String, nil]
|
|
313
352
|
# @param value [String, Array<Object>, Object, Float, Boolean, nil]
|
|
314
353
|
|
|
315
|
-
# @see FinchAPI::Models::HRIS::EmploymentData::
|
|
354
|
+
# @see FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField#value
|
|
316
355
|
module Value
|
|
317
356
|
extend FinchAPI::Internal::Type::Union
|
|
318
357
|
|
|
319
358
|
variant String
|
|
320
359
|
|
|
321
|
-
variant -> { FinchAPI::Models::HRIS::EmploymentData::
|
|
360
|
+
variant -> { FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField::Value::UnionMember1Array }
|
|
322
361
|
|
|
323
362
|
variant FinchAPI::Internal::Type::Unknown
|
|
324
363
|
|
|
@@ -364,7 +403,7 @@ module FinchAPI
|
|
|
364
403
|
end
|
|
365
404
|
|
|
366
405
|
# @!method self.variants
|
|
367
|
-
# @return [Array(FinchAPI::Models::HRIS::EmploymentData::
|
|
406
|
+
# @return [Array(FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody, FinchAPI::Models::HRIS::EmploymentData::BatchError)]
|
|
368
407
|
end
|
|
369
408
|
end
|
|
370
409
|
end
|
|
@@ -7,7 +7,7 @@ module FinchAPI
|
|
|
7
7
|
class EmploymentDataResponse < FinchAPI::Internal::Type::BaseModel
|
|
8
8
|
# @!attribute body
|
|
9
9
|
#
|
|
10
|
-
# @return [FinchAPI::Models::HRIS::EmploymentData::
|
|
10
|
+
# @return [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody, FinchAPI::Models::HRIS::EmploymentData::BatchError]
|
|
11
11
|
required :body, union: -> { FinchAPI::HRIS::EmploymentData }
|
|
12
12
|
|
|
13
13
|
# @!attribute code
|
|
@@ -22,7 +22,7 @@ module FinchAPI
|
|
|
22
22
|
required :individual_id, String
|
|
23
23
|
|
|
24
24
|
# @!method initialize(body:, code:, individual_id:)
|
|
25
|
-
# @param body [FinchAPI::Models::HRIS::EmploymentData::
|
|
25
|
+
# @param body [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody, FinchAPI::Models::HRIS::EmploymentData::BatchError]
|
|
26
26
|
#
|
|
27
27
|
# @param code [Integer]
|
|
28
28
|
#
|
|
@@ -6,11 +6,11 @@ module FinchAPI
|
|
|
6
6
|
module Individual
|
|
7
7
|
extend FinchAPI::Internal::Type::Union
|
|
8
8
|
|
|
9
|
-
variant -> { FinchAPI::HRIS::Individual::
|
|
9
|
+
variant -> { FinchAPI::HRIS::Individual::IndividualResponseBody }
|
|
10
10
|
|
|
11
11
|
variant -> { FinchAPI::HRIS::Individual::BatchError }
|
|
12
12
|
|
|
13
|
-
class
|
|
13
|
+
class IndividualResponseBody < FinchAPI::Internal::Type::BaseModel
|
|
14
14
|
# @!attribute id
|
|
15
15
|
# A stable Finch `id` (UUID v4) for an individual in the company.
|
|
16
16
|
#
|
|
@@ -25,8 +25,10 @@ module FinchAPI
|
|
|
25
25
|
# @!attribute ethnicity
|
|
26
26
|
# The EEOC-defined ethnicity of the individual.
|
|
27
27
|
#
|
|
28
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Individual::
|
|
29
|
-
required :ethnicity,
|
|
28
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Ethnicity, nil]
|
|
29
|
+
required :ethnicity,
|
|
30
|
+
enum: -> { FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity },
|
|
31
|
+
nil?: true
|
|
30
32
|
|
|
31
33
|
# @!attribute first_name
|
|
32
34
|
# The legal first name of the individual.
|
|
@@ -37,8 +39,12 @@ module FinchAPI
|
|
|
37
39
|
# @!attribute gender
|
|
38
40
|
# The gender of the individual.
|
|
39
41
|
#
|
|
40
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Individual::
|
|
41
|
-
required :gender,
|
|
42
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Gender, nil]
|
|
43
|
+
required :gender,
|
|
44
|
+
enum: -> {
|
|
45
|
+
FinchAPI::HRIS::Individual::IndividualResponseBody::Gender
|
|
46
|
+
},
|
|
47
|
+
nil?: true
|
|
42
48
|
|
|
43
49
|
# @!attribute last_name
|
|
44
50
|
# The legal last name of the individual.
|
|
@@ -54,10 +60,10 @@ module FinchAPI
|
|
|
54
60
|
|
|
55
61
|
# @!attribute phone_numbers
|
|
56
62
|
#
|
|
57
|
-
# @return [Array<FinchAPI::Models::HRIS::Individual::
|
|
63
|
+
# @return [Array<FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber, nil>, nil]
|
|
58
64
|
required :phone_numbers,
|
|
59
65
|
-> {
|
|
60
|
-
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Individual::
|
|
66
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber,
|
|
61
67
|
nil?: true]
|
|
62
68
|
},
|
|
63
69
|
nil?: true
|
|
@@ -75,9 +81,11 @@ module FinchAPI
|
|
|
75
81
|
|
|
76
82
|
# @!attribute emails
|
|
77
83
|
#
|
|
78
|
-
# @return [Array<FinchAPI::Models::HRIS::Individual::
|
|
84
|
+
# @return [Array<FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Email>, nil]
|
|
79
85
|
optional :emails,
|
|
80
|
-
-> {
|
|
86
|
+
-> {
|
|
87
|
+
FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Individual::IndividualResponseBody::Email]
|
|
88
|
+
},
|
|
81
89
|
nil?: true
|
|
82
90
|
|
|
83
91
|
# @!attribute encrypted_ssn
|
|
@@ -99,29 +107,29 @@ module FinchAPI
|
|
|
99
107
|
|
|
100
108
|
# @!method initialize(id:, dob:, ethnicity:, first_name:, gender:, last_name:, middle_name:, phone_numbers:, preferred_name:, residence:, emails: nil, encrypted_ssn: nil, ssn: nil)
|
|
101
109
|
# Some parameter documentations has been truncated, see
|
|
102
|
-
# {FinchAPI::Models::HRIS::Individual::
|
|
110
|
+
# {FinchAPI::Models::HRIS::Individual::IndividualResponseBody} for more details.
|
|
103
111
|
#
|
|
104
112
|
# @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
|
|
105
113
|
#
|
|
106
114
|
# @param dob [String, nil]
|
|
107
115
|
#
|
|
108
|
-
# @param ethnicity [Symbol, FinchAPI::Models::HRIS::Individual::
|
|
116
|
+
# @param ethnicity [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
|
|
109
117
|
#
|
|
110
118
|
# @param first_name [String, nil] The legal first name of the individual.
|
|
111
119
|
#
|
|
112
|
-
# @param gender [Symbol, FinchAPI::Models::HRIS::Individual::
|
|
120
|
+
# @param gender [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Gender, nil] The gender of the individual.
|
|
113
121
|
#
|
|
114
122
|
# @param last_name [String, nil] The legal last name of the individual.
|
|
115
123
|
#
|
|
116
124
|
# @param middle_name [String, nil] The legal middle name of the individual.
|
|
117
125
|
#
|
|
118
|
-
# @param phone_numbers [Array<FinchAPI::Models::HRIS::Individual::
|
|
126
|
+
# @param phone_numbers [Array<FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber, nil>, nil]
|
|
119
127
|
#
|
|
120
128
|
# @param preferred_name [String, nil] The preferred name of the individual.
|
|
121
129
|
#
|
|
122
130
|
# @param residence [FinchAPI::Models::Location, nil]
|
|
123
131
|
#
|
|
124
|
-
# @param emails [Array<FinchAPI::Models::HRIS::Individual::
|
|
132
|
+
# @param emails [Array<FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Email>, nil]
|
|
125
133
|
#
|
|
126
134
|
# @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
|
|
127
135
|
#
|
|
@@ -129,7 +137,7 @@ module FinchAPI
|
|
|
129
137
|
|
|
130
138
|
# The EEOC-defined ethnicity of the individual.
|
|
131
139
|
#
|
|
132
|
-
# @see FinchAPI::Models::HRIS::Individual::
|
|
140
|
+
# @see FinchAPI::Models::HRIS::Individual::IndividualResponseBody#ethnicity
|
|
133
141
|
module Ethnicity
|
|
134
142
|
extend FinchAPI::Internal::Type::Enum
|
|
135
143
|
|
|
@@ -148,7 +156,7 @@ module FinchAPI
|
|
|
148
156
|
|
|
149
157
|
# The gender of the individual.
|
|
150
158
|
#
|
|
151
|
-
# @see FinchAPI::Models::HRIS::Individual::
|
|
159
|
+
# @see FinchAPI::Models::HRIS::Individual::IndividualResponseBody#gender
|
|
152
160
|
module Gender
|
|
153
161
|
extend FinchAPI::Internal::Type::Enum
|
|
154
162
|
|
|
@@ -169,18 +177,16 @@ module FinchAPI
|
|
|
169
177
|
|
|
170
178
|
# @!attribute type
|
|
171
179
|
#
|
|
172
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Individual::
|
|
180
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type, nil]
|
|
173
181
|
required :type,
|
|
174
|
-
enum: -> {
|
|
175
|
-
FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type
|
|
176
|
-
},
|
|
182
|
+
enum: -> { FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type },
|
|
177
183
|
nil?: true
|
|
178
184
|
|
|
179
185
|
# @!method initialize(data:, type:)
|
|
180
186
|
# @param data [String, nil]
|
|
181
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::Individual::
|
|
187
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type, nil]
|
|
182
188
|
|
|
183
|
-
# @see FinchAPI::Models::HRIS::Individual::
|
|
189
|
+
# @see FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber#type
|
|
184
190
|
module Type
|
|
185
191
|
extend FinchAPI::Internal::Type::Enum
|
|
186
192
|
|
|
@@ -200,14 +206,18 @@ module FinchAPI
|
|
|
200
206
|
|
|
201
207
|
# @!attribute type
|
|
202
208
|
#
|
|
203
|
-
# @return [Symbol, FinchAPI::Models::HRIS::Individual::
|
|
204
|
-
required :type,
|
|
209
|
+
# @return [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Email::Type, nil]
|
|
210
|
+
required :type,
|
|
211
|
+
enum: -> {
|
|
212
|
+
FinchAPI::HRIS::Individual::IndividualResponseBody::Email::Type
|
|
213
|
+
},
|
|
214
|
+
nil?: true
|
|
205
215
|
|
|
206
216
|
# @!method initialize(data:, type:)
|
|
207
217
|
# @param data [String]
|
|
208
|
-
# @param type [Symbol, FinchAPI::Models::HRIS::Individual::
|
|
218
|
+
# @param type [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Email::Type, nil]
|
|
209
219
|
|
|
210
|
-
# @see FinchAPI::Models::HRIS::Individual::
|
|
220
|
+
# @see FinchAPI::Models::HRIS::Individual::IndividualResponseBody::Email#type
|
|
211
221
|
module Type
|
|
212
222
|
extend FinchAPI::Internal::Type::Enum
|
|
213
223
|
|
|
@@ -249,7 +259,7 @@ module FinchAPI
|
|
|
249
259
|
end
|
|
250
260
|
|
|
251
261
|
# @!method self.variants
|
|
252
|
-
# @return [Array(FinchAPI::Models::HRIS::Individual::
|
|
262
|
+
# @return [Array(FinchAPI::Models::HRIS::Individual::IndividualResponseBody, FinchAPI::Models::HRIS::Individual::BatchError)]
|
|
253
263
|
end
|
|
254
264
|
end
|
|
255
265
|
end
|
|
@@ -7,7 +7,7 @@ module FinchAPI
|
|
|
7
7
|
class IndividualResponse < FinchAPI::Internal::Type::BaseModel
|
|
8
8
|
# @!attribute body
|
|
9
9
|
#
|
|
10
|
-
# @return [FinchAPI::Models::HRIS::Individual::
|
|
10
|
+
# @return [FinchAPI::Models::HRIS::Individual::IndividualResponseBody, FinchAPI::Models::HRIS::Individual::BatchError]
|
|
11
11
|
required :body, union: -> { FinchAPI::HRIS::Individual }
|
|
12
12
|
|
|
13
13
|
# @!attribute code
|
|
@@ -21,7 +21,7 @@ module FinchAPI
|
|
|
21
21
|
required :individual_id, String
|
|
22
22
|
|
|
23
23
|
# @!method initialize(body:, code:, individual_id:)
|
|
24
|
-
# @param body [FinchAPI::Models::HRIS::Individual::
|
|
24
|
+
# @param body [FinchAPI::Models::HRIS::Individual::IndividualResponseBody, FinchAPI::Models::HRIS::Individual::BatchError]
|
|
25
25
|
# @param code [Integer]
|
|
26
26
|
# @param individual_id [String]
|
|
27
27
|
end
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module FinchAPI
|
|
4
|
+
module Models
|
|
5
|
+
module HRIS
|
|
6
|
+
# @see FinchAPI::Resources::HRIS::Benefits#register
|
|
7
|
+
class RegisterCompanyBenefitResponse < FinchAPI::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute benefit_id
|
|
9
|
+
# The id of the benefit.
|
|
10
|
+
#
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :benefit_id, String
|
|
13
|
+
|
|
14
|
+
# @!attribute job_id
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :job_id, String
|
|
18
|
+
|
|
19
|
+
# @!method initialize(benefit_id:, job_id:)
|
|
20
|
+
# @param benefit_id [String] The id of the benefit.
|
|
21
|
+
#
|
|
22
|
+
# @param job_id [String]
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|