vitable-connect 0.4.0 → 0.6.0
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 +52 -0
- data/README.md +9 -9
- data/lib/vitable_connect/client.rb +19 -6
- data/lib/vitable_connect/internal/transport/base_client.rb +28 -4
- data/lib/vitable_connect/internal/type/enum.rb +13 -9
- data/lib/vitable_connect/models/auth_issue_access_token_params.rb +17 -3
- data/lib/vitable_connect/models/auth_issue_access_token_response.rb +17 -3
- data/lib/vitable_connect/models/employee.rb +98 -30
- data/lib/vitable_connect/models/employee_update_params.rb +185 -0
- data/lib/vitable_connect/models/employee_update_response.rb +18 -0
- data/lib/vitable_connect/models/employer.rb +36 -10
- data/lib/vitable_connect/models/employer_ensure_payroll_integration_email_params.rb +22 -0
- data/lib/vitable_connect/models/employer_ensure_payroll_integration_email_response.rb +29 -0
- data/lib/vitable_connect/models/employer_list_benefit_plan_year_enrollments_params.rb +80 -0
- data/lib/vitable_connect/models/employer_list_benefit_plan_year_enrollments_response.rb +175 -0
- data/lib/vitable_connect/models/employer_list_benefit_plan_years_params.rb +22 -0
- data/lib/vitable_connect/models/employer_list_benefit_plan_years_response.rb +301 -0
- data/lib/vitable_connect/models/employer_list_employees_params.rb +28 -1
- data/lib/vitable_connect/models/employer_list_hris_providers_params.rb +14 -0
- data/lib/vitable_connect/models/employer_list_hris_providers_response.rb +30 -0
- data/lib/vitable_connect/models/employer_list_invoices_params.rb +38 -0
- data/lib/vitable_connect/models/employer_list_invoices_response.rb +77 -0
- data/lib/vitable_connect/models/employer_list_params.rb +118 -5
- data/lib/vitable_connect/models/employer_list_payroll_deduction_statements_params.rb +38 -0
- data/lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb +113 -0
- data/lib/vitable_connect/models/employer_list_response.rb +283 -0
- data/lib/vitable_connect/models/employer_retrieve_benefit_plan_year_params.rb +30 -0
- data/lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb +813 -0
- data/lib/vitable_connect/models/employer_retrieve_hris_params.rb +22 -0
- data/lib/vitable_connect/models/employer_retrieve_hris_response.rb +55 -0
- data/lib/vitable_connect/models/employer_retrieve_invoice_pdf_params.rb +30 -0
- data/lib/vitable_connect/models/employer_retrieve_invoice_pdf_response.rb +17 -0
- data/lib/vitable_connect/models/employer_retrieve_payroll_access_setup_params.rb +22 -0
- data/lib/vitable_connect/models/employer_retrieve_payroll_access_setup_response.rb +35 -0
- data/lib/vitable_connect/models/employer_submit_census_sync_params.rb +9 -8
- data/lib/vitable_connect/models/employer_submit_payroll_access_setup_params.rb +267 -0
- data/lib/vitable_connect/models/employer_submit_payroll_access_setup_response.rb +35 -0
- data/lib/vitable_connect/models/employer_update_params.rb +99 -0
- data/lib/vitable_connect/models/employer_update_settings_params.rb +9 -9
- data/lib/vitable_connect/models/employer_update_settings_response.rb +4 -4
- data/lib/vitable_connect/models/enrollment_reissue_params.rb +50 -0
- data/lib/vitable_connect/models/enrollment_reissue_response.rb +30 -0
- data/lib/vitable_connect/models/enrollment_terminate_params.rb +50 -0
- data/lib/vitable_connect/models/group.rb +17 -6
- data/lib/vitable_connect/models/groups/members/sync_retrieve_response.rb +74 -3
- data/lib/vitable_connect/models/groups/members/sync_submit_params.rb +7 -7
- data/lib/vitable_connect/models/member_list_dependents_params.rb +20 -0
- data/lib/vitable_connect/models/member_list_dependents_response.rb +132 -0
- data/lib/vitable_connect/models/member_list_employments_params.rb +20 -0
- data/lib/vitable_connect/models/member_list_employments_response.rb +18 -0
- data/lib/vitable_connect/models/member_list_enrollments_params.rb +20 -0
- data/lib/vitable_connect/models/member_list_enrollments_response.rb +319 -0
- data/lib/vitable_connect/models/member_list_id_cards_params.rb +20 -0
- data/lib/vitable_connect/models/member_list_id_cards_response.rb +368 -0
- data/lib/vitable_connect/models/member_list_params.rb +38 -0
- data/lib/vitable_connect/models/member_list_qualifying_life_events_params.rb +57 -0
- data/lib/vitable_connect/models/member_list_qualifying_life_events_response.rb +96 -0
- data/lib/vitable_connect/models/member_list_response.rb +108 -0
- data/lib/vitable_connect/models/member_retrieve_household_params.rb +20 -0
- data/lib/vitable_connect/models/member_retrieve_household_response.rb +128 -0
- data/lib/vitable_connect/models/member_retrieve_params.rb +20 -0
- data/lib/vitable_connect/models/member_retrieve_response.rb +195 -0
- data/lib/vitable_connect/models/organization_create_params.rb +57 -0
- data/lib/vitable_connect/models/organization_create_response.rb +104 -0
- data/lib/vitable_connect/models/organization_list_params.rb +14 -0
- data/lib/vitable_connect/models/organization_list_response.rb +128 -0
- data/lib/vitable_connect/models/webhook_event_list_params.rb +3 -3
- data/lib/vitable_connect/models.rb +54 -11
- data/lib/vitable_connect/resources/employees.rb +49 -3
- data/lib/vitable_connect/resources/employers.rb +402 -28
- data/lib/vitable_connect/resources/enrollments.rb +75 -0
- data/lib/vitable_connect/resources/members.rb +231 -0
- data/lib/vitable_connect/resources/organizations.rb +66 -0
- data/lib/vitable_connect/version.rb +1 -1
- data/lib/vitable_connect.rb +51 -6
- data/rbi/vitable_connect/client.rbi +18 -6
- data/rbi/vitable_connect/internal/transport/base_client.rbi +4 -1
- data/rbi/vitable_connect/models/auth_issue_access_token_params.rbi +53 -5
- data/rbi/vitable_connect/models/auth_issue_access_token_response.rbi +51 -5
- data/rbi/vitable_connect/models/employee.rbi +138 -37
- data/rbi/vitable_connect/models/employee_update_params.rbi +323 -0
- data/rbi/vitable_connect/models/employee_update_response.rbi +32 -0
- data/rbi/vitable_connect/models/employer.rbi +58 -8
- data/rbi/vitable_connect/models/employer_ensure_payroll_integration_email_params.rbi +46 -0
- data/rbi/vitable_connect/models/employer_ensure_payroll_integration_email_response.rbi +72 -0
- data/rbi/vitable_connect/models/employer_list_benefit_plan_year_enrollments_params.rbi +165 -0
- data/rbi/vitable_connect/models/employer_list_benefit_plan_year_enrollments_response.rbi +278 -0
- data/rbi/vitable_connect/models/{benefit_eligibility_policy_retrieve_params.rbi → employer_list_benefit_plan_years_params.rbi} +11 -8
- data/rbi/vitable_connect/models/employer_list_benefit_plan_years_response.rbi +539 -0
- data/rbi/vitable_connect/models/employer_list_employees_params.rbi +70 -0
- data/rbi/vitable_connect/models/employer_list_hris_providers_params.rbi +32 -0
- data/rbi/vitable_connect/models/employer_list_hris_providers_response.rbi +74 -0
- data/rbi/vitable_connect/models/employer_list_invoices_params.rbi +65 -0
- data/rbi/vitable_connect/models/employer_list_invoices_response.rbi +151 -0
- data/rbi/vitable_connect/models/employer_list_params.rbi +292 -4
- data/rbi/vitable_connect/models/{employer_create_benefit_eligibility_policy_params.rbi → employer_list_payroll_deduction_statements_params.rbi} +22 -18
- data/rbi/vitable_connect/models/employer_list_payroll_deduction_statements_response.rbi +169 -0
- data/rbi/vitable_connect/models/employer_list_response.rbi +426 -0
- data/rbi/vitable_connect/models/employer_retrieve_benefit_plan_year_params.rbi +54 -0
- data/rbi/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rbi +1574 -0
- data/rbi/vitable_connect/models/employer_retrieve_hris_params.rbi +46 -0
- data/rbi/vitable_connect/models/employer_retrieve_hris_response.rbi +120 -0
- data/rbi/vitable_connect/models/employer_retrieve_invoice_pdf_params.rbi +54 -0
- data/rbi/vitable_connect/models/employer_retrieve_invoice_pdf_response.rbi +30 -0
- data/rbi/vitable_connect/models/employer_retrieve_payroll_access_setup_params.rbi +46 -0
- data/rbi/vitable_connect/models/employer_retrieve_payroll_access_setup_response.rbi +83 -0
- data/rbi/vitable_connect/models/employer_submit_census_sync_params.rbi +8 -6
- data/rbi/vitable_connect/models/employer_submit_payroll_access_setup_params.rbi +441 -0
- data/rbi/vitable_connect/models/employer_submit_payroll_access_setup_response.rbi +83 -0
- data/rbi/vitable_connect/models/employer_update_params.rbi +155 -0
- data/rbi/vitable_connect/models/employer_update_settings_params.rbi +12 -12
- data/rbi/vitable_connect/models/employer_update_settings_response.rbi +6 -6
- data/rbi/vitable_connect/models/enrollment_reissue_params.rbi +72 -0
- data/rbi/vitable_connect/models/enrollment_reissue_response.rbi +67 -0
- data/rbi/vitable_connect/models/enrollment_terminate_params.rbi +72 -0
- data/rbi/vitable_connect/models/group.rbi +12 -0
- data/rbi/vitable_connect/models/groups/members/sync_retrieve_response.rbi +174 -4
- data/rbi/vitable_connect/models/groups/members/sync_submit_params.rbi +9 -9
- data/rbi/vitable_connect/models/member_list_dependents_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_list_dependents_response.rbi +249 -0
- data/rbi/vitable_connect/models/member_list_employments_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_list_employments_response.rbi +31 -0
- data/rbi/vitable_connect/models/member_list_enrollments_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_list_enrollments_response.rbi +579 -0
- data/rbi/vitable_connect/models/member_list_id_cards_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_list_id_cards_response.rbi +624 -0
- data/rbi/vitable_connect/models/member_list_params.rbi +71 -0
- data/rbi/vitable_connect/models/member_list_qualifying_life_events_params.rbi +130 -0
- data/rbi/vitable_connect/models/member_list_qualifying_life_events_response.rbi +192 -0
- data/rbi/vitable_connect/models/member_list_response.rbi +166 -0
- data/rbi/vitable_connect/models/member_retrieve_household_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_retrieve_household_response.rbi +251 -0
- data/rbi/vitable_connect/models/member_retrieve_params.rbi +38 -0
- data/rbi/vitable_connect/models/member_retrieve_response.rbi +312 -0
- data/rbi/vitable_connect/models/organization_create_params.rbi +127 -0
- data/rbi/vitable_connect/models/organization_create_response.rbi +212 -0
- data/rbi/vitable_connect/models/organization_list_params.rbi +32 -0
- data/rbi/vitable_connect/models/organization_list_response.rbi +266 -0
- data/rbi/vitable_connect/models/webhook_event_list_params.rbi +8 -8
- data/rbi/vitable_connect/models.rbi +66 -13
- data/rbi/vitable_connect/resources/employees.rbi +62 -3
- data/rbi/vitable_connect/resources/employers.rbi +373 -24
- data/rbi/vitable_connect/resources/enrollments.rbi +61 -0
- data/rbi/vitable_connect/resources/members.rbi +169 -0
- data/rbi/vitable_connect/resources/organizations.rbi +48 -0
- data/rbi/vitable_connect/resources/webhook_events.rbi +1 -1
- data/sig/vitable_connect/client.rbs +9 -3
- data/sig/vitable_connect/internal/transport/base_client.rbs +2 -0
- data/sig/vitable_connect/models/auth_issue_access_token_params.rbs +22 -4
- data/sig/vitable_connect/models/auth_issue_access_token_response.rbs +22 -4
- data/sig/vitable_connect/models/employee.rbs +65 -18
- data/sig/vitable_connect/models/employee_update_params.rbs +140 -0
- data/sig/vitable_connect/models/employee_update_response.rbs +13 -0
- data/sig/vitable_connect/models/employer.rbs +17 -5
- data/sig/vitable_connect/models/employer_ensure_payroll_integration_email_params.rbs +24 -0
- data/sig/vitable_connect/models/employer_ensure_payroll_integration_email_response.rbs +30 -0
- data/sig/vitable_connect/models/employer_list_benefit_plan_year_enrollments_params.rbs +74 -0
- data/sig/vitable_connect/models/employer_list_benefit_plan_year_enrollments_response.rbs +111 -0
- data/sig/vitable_connect/models/employer_list_benefit_plan_years_params.rbs +24 -0
- data/sig/vitable_connect/models/employer_list_benefit_plan_years_response.rbs +197 -0
- data/sig/vitable_connect/models/employer_list_employees_params.rbs +32 -1
- data/sig/vitable_connect/models/employer_list_hris_providers_params.rbs +15 -0
- data/sig/vitable_connect/models/employer_list_hris_providers_response.rbs +30 -0
- data/sig/vitable_connect/models/employer_list_invoices_params.rbs +34 -0
- data/sig/vitable_connect/models/employer_list_invoices_response.rbs +62 -0
- data/sig/vitable_connect/models/employer_list_params.rbs +94 -1
- data/sig/vitable_connect/models/{employer_create_benefit_eligibility_policy_params.rbs → employer_list_payroll_deduction_statements_params.rbs} +13 -9
- data/sig/vitable_connect/models/employer_list_payroll_deduction_statements_response.rbs +73 -0
- data/sig/vitable_connect/models/employer_list_response.rbs +179 -0
- data/sig/vitable_connect/models/employer_retrieve_benefit_plan_year_params.rbs +28 -0
- data/sig/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rbs +540 -0
- data/sig/vitable_connect/models/employer_retrieve_hris_params.rbs +24 -0
- data/sig/vitable_connect/models/employer_retrieve_hris_response.rbs +50 -0
- data/sig/vitable_connect/models/employer_retrieve_invoice_pdf_params.rbs +28 -0
- data/sig/vitable_connect/models/employer_retrieve_invoice_pdf_response.rbs +13 -0
- data/sig/vitable_connect/models/employer_retrieve_payroll_access_setup_params.rbs +24 -0
- data/sig/vitable_connect/models/employer_retrieve_payroll_access_setup_response.rbs +32 -0
- data/sig/vitable_connect/models/employer_submit_census_sync_params.rbs +5 -5
- data/sig/vitable_connect/models/employer_submit_payroll_access_setup_params.rbs +198 -0
- data/sig/vitable_connect/models/employer_submit_payroll_access_setup_response.rbs +32 -0
- data/sig/vitable_connect/models/employer_update_params.rbs +83 -0
- data/sig/vitable_connect/models/enrollment_reissue_params.rbs +41 -0
- data/sig/vitable_connect/models/enrollment_reissue_response.rbs +28 -0
- data/sig/vitable_connect/models/enrollment_terminate_params.rbs +41 -0
- data/sig/vitable_connect/models/groups/members/sync_retrieve_response.rbs +69 -4
- data/sig/vitable_connect/models/groups/members/sync_submit_params.rbs +8 -8
- data/sig/vitable_connect/models/{benefit_eligibility_policy_retrieve_params.rbs → member_list_dependents_params.rbs} +6 -6
- data/sig/vitable_connect/models/member_list_dependents_response.rbs +96 -0
- data/sig/vitable_connect/models/member_list_employments_params.rbs +23 -0
- data/sig/vitable_connect/models/member_list_employments_response.rbs +14 -0
- data/sig/vitable_connect/models/member_list_enrollments_params.rbs +23 -0
- data/sig/vitable_connect/models/member_list_enrollments_response.rbs +215 -0
- data/sig/vitable_connect/models/member_list_id_cards_params.rbs +23 -0
- data/sig/vitable_connect/models/member_list_id_cards_response.rbs +256 -0
- data/sig/vitable_connect/models/member_list_params.rbs +38 -0
- data/sig/vitable_connect/models/member_list_qualifying_life_events_params.rbs +61 -0
- data/sig/vitable_connect/models/member_list_qualifying_life_events_response.rbs +67 -0
- data/sig/vitable_connect/models/member_list_response.rbs +82 -0
- data/sig/vitable_connect/models/member_retrieve_household_params.rbs +23 -0
- data/sig/vitable_connect/models/member_retrieve_household_response.rbs +92 -0
- data/sig/vitable_connect/models/member_retrieve_params.rbs +23 -0
- data/sig/vitable_connect/models/member_retrieve_response.rbs +143 -0
- data/sig/vitable_connect/models/organization_create_params.rbs +52 -0
- data/sig/vitable_connect/models/organization_create_response.rbs +77 -0
- data/sig/vitable_connect/models/organization_list_params.rbs +15 -0
- data/sig/vitable_connect/models/organization_list_response.rbs +99 -0
- data/sig/vitable_connect/models/webhook_event_list_params.rbs +2 -2
- data/sig/vitable_connect/models.rbs +50 -10
- data/sig/vitable_connect/resources/employees.rbs +13 -0
- data/sig/vitable_connect/resources/employers.rbs +103 -5
- data/sig/vitable_connect/resources/enrollments.rbs +16 -0
- data/sig/vitable_connect/resources/members.rbs +52 -0
- data/sig/vitable_connect/resources/organizations.rbs +17 -0
- metadata +155 -20
- data/lib/vitable_connect/models/benefit_eligibility_policy.rb +0 -53
- data/lib/vitable_connect/models/benefit_eligibility_policy_response.rb +0 -18
- data/lib/vitable_connect/models/benefit_eligibility_policy_retrieve_params.rb +0 -22
- data/lib/vitable_connect/models/employer_create_benefit_eligibility_policy_params.rb +0 -43
- data/lib/vitable_connect/models/type.rb +0 -17
- data/lib/vitable_connect/resources/benefit_eligibility_policies.rb +0 -35
- data/rbi/vitable_connect/models/benefit_eligibility_policy.rbi +0 -74
- data/rbi/vitable_connect/models/benefit_eligibility_policy_response.rbi +0 -38
- data/rbi/vitable_connect/models/type.rbi +0 -21
- data/rbi/vitable_connect/resources/benefit_eligibility_policies.rbi +0 -27
- data/sig/vitable_connect/models/benefit_eligibility_policy.rbs +0 -50
- data/sig/vitable_connect/models/benefit_eligibility_policy_response.rbs +0 -14
- data/sig/vitable_connect/models/type.rbs +0 -14
- data/sig/vitable_connect/resources/benefit_eligibility_policies.rbs +0 -12
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Employers#retrieve_hris
|
|
6
|
+
class EmployerRetrieveHRISParams < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
extend VitableConnect::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include VitableConnect::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute employer_id
|
|
11
|
+
# Unique employer identifier (empr\_\*)
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :employer_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(employer_id:, request_options: {})
|
|
17
|
+
# @param employer_id [String] Unique employer identifier (empr\_\*)
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Employers#retrieve_hris
|
|
6
|
+
class EmployerRetrieveHRISResponse < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute hris
|
|
8
|
+
# HRIS connection details, or null when the employer has no integration.
|
|
9
|
+
#
|
|
10
|
+
# @return [VitableConnect::Models::EmployerRetrieveHRISResponse::HRIS, nil]
|
|
11
|
+
required :hris, -> { VitableConnect::Models::EmployerRetrieveHRISResponse::HRIS }, nil?: true
|
|
12
|
+
|
|
13
|
+
# @!method initialize(hris:)
|
|
14
|
+
# @param hris [VitableConnect::Models::EmployerRetrieveHRISResponse::HRIS, nil] HRIS connection details, or null when the employer has no integration.
|
|
15
|
+
|
|
16
|
+
# @see VitableConnect::Models::EmployerRetrieveHRISResponse#hris
|
|
17
|
+
class HRIS < VitableConnect::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute last_sync_on
|
|
19
|
+
# When the last sync completed, or null when none has.
|
|
20
|
+
#
|
|
21
|
+
# @return [Time, nil]
|
|
22
|
+
required :last_sync_on, Time, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!attribute provider
|
|
25
|
+
# HRIS/payroll provider the employer is connected to (e.g. `Paychex`).
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :provider, String
|
|
29
|
+
|
|
30
|
+
# @!attribute status
|
|
31
|
+
# Connection status reported by the integration.
|
|
32
|
+
#
|
|
33
|
+
# @return [String]
|
|
34
|
+
required :status, String
|
|
35
|
+
|
|
36
|
+
# @!attribute synced_row_count
|
|
37
|
+
# Rows in the latest completed sync, or null when none has.
|
|
38
|
+
#
|
|
39
|
+
# @return [Integer, nil]
|
|
40
|
+
required :synced_row_count, Integer, nil?: true
|
|
41
|
+
|
|
42
|
+
# @!method initialize(last_sync_on:, provider:, status:, synced_row_count:)
|
|
43
|
+
# HRIS connection details, or null when the employer has no integration.
|
|
44
|
+
#
|
|
45
|
+
# @param last_sync_on [Time, nil] When the last sync completed, or null when none has.
|
|
46
|
+
#
|
|
47
|
+
# @param provider [String] HRIS/payroll provider the employer is connected to (e.g. `Paychex`).
|
|
48
|
+
#
|
|
49
|
+
# @param status [String] Connection status reported by the integration.
|
|
50
|
+
#
|
|
51
|
+
# @param synced_row_count [Integer, nil] Rows in the latest completed sync, or null when none has.
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Employers#retrieve_invoice_pdf
|
|
6
|
+
class EmployerRetrieveInvoicePdfParams < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
extend VitableConnect::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include VitableConnect::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute employer_id
|
|
11
|
+
# Unique employer identifier (empr\_\*)
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :employer_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute invoice_id
|
|
17
|
+
# External Chargebee invoice id (not a prefixed UUID).
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :invoice_id, String
|
|
21
|
+
|
|
22
|
+
# @!method initialize(employer_id:, invoice_id:, request_options: {})
|
|
23
|
+
# @param employer_id [String] Unique employer identifier (empr\_\*)
|
|
24
|
+
#
|
|
25
|
+
# @param invoice_id [String] External Chargebee invoice id (not a prefixed UUID).
|
|
26
|
+
#
|
|
27
|
+
# @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Employers#retrieve_invoice_pdf
|
|
6
|
+
class EmployerRetrieveInvoicePdfResponse < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute download_url
|
|
8
|
+
# Time-limited Chargebee PDF download link for the invoice.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :download_url, String
|
|
12
|
+
|
|
13
|
+
# @!method initialize(download_url:)
|
|
14
|
+
# @param download_url [String] Time-limited Chargebee PDF download link for the invoice.
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Employers#retrieve_payroll_access_setup
|
|
6
|
+
class EmployerRetrievePayrollAccessSetupParams < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
extend VitableConnect::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include VitableConnect::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute employer_id
|
|
11
|
+
# Unique employer identifier (empr\_\*)
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :employer_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(employer_id:, request_options: {})
|
|
17
|
+
# @param employer_id [String] Unique employer identifier (empr\_\*)
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Employers#retrieve_payroll_access_setup
|
|
6
|
+
class EmployerRetrievePayrollAccessSetupResponse < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [VitableConnect::Models::EmployerRetrievePayrollAccessSetupResponse::Data]
|
|
10
|
+
required :data, -> { VitableConnect::Models::EmployerRetrievePayrollAccessSetupResponse::Data }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(data:)
|
|
13
|
+
# Response containing a single payroll access setup status resource.
|
|
14
|
+
#
|
|
15
|
+
# @param data [VitableConnect::Models::EmployerRetrievePayrollAccessSetupResponse::Data]
|
|
16
|
+
|
|
17
|
+
# @see VitableConnect::Models::EmployerRetrievePayrollAccessSetupResponse#data
|
|
18
|
+
class Data < VitableConnect::Internal::Type::BaseModel
|
|
19
|
+
# @!attribute completed
|
|
20
|
+
#
|
|
21
|
+
# @return [Boolean]
|
|
22
|
+
required :completed, VitableConnect::Internal::Type::Boolean
|
|
23
|
+
|
|
24
|
+
# @!attribute submitted_at
|
|
25
|
+
#
|
|
26
|
+
# @return [Time, nil]
|
|
27
|
+
required :submitted_at, Time, nil?: true
|
|
28
|
+
|
|
29
|
+
# @!method initialize(completed:, submitted_at:)
|
|
30
|
+
# @param completed [Boolean]
|
|
31
|
+
# @param submitted_at [Time, nil]
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
@@ -47,11 +47,6 @@ module VitableConnect
|
|
|
47
47
|
# @return [String]
|
|
48
48
|
required :last_name, String
|
|
49
49
|
|
|
50
|
-
# @!attribute phone
|
|
51
|
-
#
|
|
52
|
-
# @return [String]
|
|
53
|
-
required :phone, String
|
|
54
|
-
|
|
55
50
|
# @!attribute address
|
|
56
51
|
#
|
|
57
52
|
# @return [VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address, nil]
|
|
@@ -81,6 +76,12 @@ module VitableConnect
|
|
|
81
76
|
# @return [Symbol, VitableConnect::Models::EmployeeClass, nil]
|
|
82
77
|
optional :employee_class, enum: -> { VitableConnect::EmployeeClass }, nil?: true
|
|
83
78
|
|
|
79
|
+
# @!attribute phone
|
|
80
|
+
# Phone number
|
|
81
|
+
#
|
|
82
|
+
# @return [String, nil]
|
|
83
|
+
optional :phone, String, nil?: true
|
|
84
|
+
|
|
84
85
|
# @!attribute reference_id
|
|
85
86
|
#
|
|
86
87
|
# @return [String, nil]
|
|
@@ -91,7 +92,7 @@ module VitableConnect
|
|
|
91
92
|
# @return [Date, nil]
|
|
92
93
|
optional :start_date, Date, nil?: true
|
|
93
94
|
|
|
94
|
-
# @!method initialize(date_of_birth:, email:, first_name:, last_name:,
|
|
95
|
+
# @!method initialize(date_of_birth:, email:, first_name:, last_name:, address: nil, compensation_type: nil, employee_class: nil, phone: nil, reference_id: nil, start_date: nil)
|
|
95
96
|
# Some parameter documentations has been truncated, see
|
|
96
97
|
# {VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee} for more
|
|
97
98
|
# details.
|
|
@@ -104,14 +105,14 @@ module VitableConnect
|
|
|
104
105
|
#
|
|
105
106
|
# @param last_name [String]
|
|
106
107
|
#
|
|
107
|
-
# @param phone [String]
|
|
108
|
-
#
|
|
109
108
|
# @param address [VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address, nil]
|
|
110
109
|
#
|
|
111
110
|
# @param compensation_type [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::CompensationType, nil] - `Salary` - Salary
|
|
112
111
|
#
|
|
113
112
|
# @param employee_class [Symbol, VitableConnect::Models::EmployeeClass, nil] - `Full Time` - Full Time
|
|
114
113
|
#
|
|
114
|
+
# @param phone [String, nil] Phone number
|
|
115
|
+
#
|
|
115
116
|
# @param reference_id [String, nil]
|
|
116
117
|
#
|
|
117
118
|
# @param start_date [Date, nil]
|
|
@@ -0,0 +1,267 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Employers#submit_payroll_access_setup
|
|
6
|
+
class EmployerSubmitPayrollAccessSetupParams < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
extend VitableConnect::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include VitableConnect::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute employer_id
|
|
11
|
+
# Unique employer identifier (empr\_\*)
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :employer_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute access_method
|
|
17
|
+
# - `SELF_SETUP` - SELF_SETUP
|
|
18
|
+
# - `NEEDS_HELP` - NEEDS_HELP
|
|
19
|
+
#
|
|
20
|
+
# @return [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::AccessMethod]
|
|
21
|
+
required :access_method, enum: -> { VitableConnect::EmployerSubmitPayrollAccessSetupParams::AccessMethod }
|
|
22
|
+
|
|
23
|
+
# @!attribute all_benefit_eligible_employees_present
|
|
24
|
+
#
|
|
25
|
+
# @return [Boolean]
|
|
26
|
+
required :all_benefit_eligible_employees_present, VitableConnect::Internal::Type::Boolean
|
|
27
|
+
|
|
28
|
+
# @!attribute classifications_accurate
|
|
29
|
+
#
|
|
30
|
+
# @return [Boolean]
|
|
31
|
+
required :classifications_accurate, VitableConnect::Internal::Type::Boolean
|
|
32
|
+
|
|
33
|
+
# @!attribute employees_in_payroll_acknowledged
|
|
34
|
+
#
|
|
35
|
+
# @return [Boolean]
|
|
36
|
+
required :employees_in_payroll_acknowledged, VitableConnect::Internal::Type::Boolean
|
|
37
|
+
|
|
38
|
+
# @!attribute has_additional_payroll_system
|
|
39
|
+
#
|
|
40
|
+
# @return [Boolean]
|
|
41
|
+
required :has_additional_payroll_system, VitableConnect::Internal::Type::Boolean
|
|
42
|
+
|
|
43
|
+
# @!attribute is_controlled_group
|
|
44
|
+
#
|
|
45
|
+
# @return [Boolean]
|
|
46
|
+
required :is_controlled_group, VitableConnect::Internal::Type::Boolean
|
|
47
|
+
|
|
48
|
+
# @!attribute payroll_data_impacts_eligibility_acknowledged
|
|
49
|
+
#
|
|
50
|
+
# @return [Boolean]
|
|
51
|
+
required :payroll_data_impacts_eligibility_acknowledged, VitableConnect::Internal::Type::Boolean
|
|
52
|
+
|
|
53
|
+
# @!attribute additional_access_method
|
|
54
|
+
# - `SELF_SETUP` - SELF_SETUP
|
|
55
|
+
# - `NEEDS_HELP` - NEEDS_HELP
|
|
56
|
+
#
|
|
57
|
+
# @return [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::AdditionalAccessMethod, nil]
|
|
58
|
+
optional :additional_access_method,
|
|
59
|
+
enum: -> { VitableConnect::EmployerSubmitPayrollAccessSetupParams::AdditionalAccessMethod },
|
|
60
|
+
nil?: true
|
|
61
|
+
|
|
62
|
+
# @!attribute additional_integration_confirmed
|
|
63
|
+
#
|
|
64
|
+
# @return [Boolean, nil]
|
|
65
|
+
optional :additional_integration_confirmed, VitableConnect::Internal::Type::Boolean, nil?: true
|
|
66
|
+
|
|
67
|
+
# @!attribute additional_login_url
|
|
68
|
+
#
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
optional :additional_login_url, String, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!attribute additional_password
|
|
73
|
+
#
|
|
74
|
+
# @return [String, nil]
|
|
75
|
+
optional :additional_password, String, nil?: true
|
|
76
|
+
|
|
77
|
+
# @!attribute additional_phone
|
|
78
|
+
#
|
|
79
|
+
# @return [String, nil]
|
|
80
|
+
optional :additional_phone, String, nil?: true
|
|
81
|
+
|
|
82
|
+
# @!attribute additional_username
|
|
83
|
+
#
|
|
84
|
+
# @return [String, nil]
|
|
85
|
+
optional :additional_username, String, nil?: true
|
|
86
|
+
|
|
87
|
+
# @!attribute classification_correction_source
|
|
88
|
+
# - `ENTER_NAMES` - ENTER_NAMES
|
|
89
|
+
# - `EMAIL_LIST` - EMAIL_LIST
|
|
90
|
+
#
|
|
91
|
+
# @return [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::ClassificationCorrectionSource, nil]
|
|
92
|
+
optional :classification_correction_source,
|
|
93
|
+
enum: -> {
|
|
94
|
+
VitableConnect::EmployerSubmitPayrollAccessSetupParams::ClassificationCorrectionSource
|
|
95
|
+
},
|
|
96
|
+
nil?: true
|
|
97
|
+
|
|
98
|
+
# @!attribute integration_confirmed
|
|
99
|
+
#
|
|
100
|
+
# @return [Boolean, nil]
|
|
101
|
+
optional :integration_confirmed, VitableConnect::Internal::Type::Boolean, nil?: true
|
|
102
|
+
|
|
103
|
+
# @!attribute login_url
|
|
104
|
+
#
|
|
105
|
+
# @return [String, nil]
|
|
106
|
+
optional :login_url, String, nil?: true
|
|
107
|
+
|
|
108
|
+
# @!attribute misclassified_employee_names
|
|
109
|
+
#
|
|
110
|
+
# @return [Array<String>, nil]
|
|
111
|
+
optional :misclassified_employee_names, VitableConnect::Internal::Type::ArrayOf[String]
|
|
112
|
+
|
|
113
|
+
# @!attribute missing_employee_resolution
|
|
114
|
+
# - `EMAIL_CENSUS` - EMAIL_CENSUS
|
|
115
|
+
# - `SECOND_SYSTEM_ACCESS` - SECOND_SYSTEM_ACCESS
|
|
116
|
+
#
|
|
117
|
+
# @return [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::MissingEmployeeResolution, nil]
|
|
118
|
+
optional :missing_employee_resolution,
|
|
119
|
+
enum: -> { VitableConnect::EmployerSubmitPayrollAccessSetupParams::MissingEmployeeResolution },
|
|
120
|
+
nil?: true
|
|
121
|
+
|
|
122
|
+
# @!attribute password
|
|
123
|
+
#
|
|
124
|
+
# @return [String, nil]
|
|
125
|
+
optional :password, String, nil?: true
|
|
126
|
+
|
|
127
|
+
# @!attribute phone
|
|
128
|
+
#
|
|
129
|
+
# @return [String, nil]
|
|
130
|
+
optional :phone, String, nil?: true
|
|
131
|
+
|
|
132
|
+
# @!attribute remaining_employee_action
|
|
133
|
+
# - `VITABLE_UPDATE` - VITABLE_UPDATE
|
|
134
|
+
# - `EMPLOYER_UPDATE` - EMPLOYER_UPDATE
|
|
135
|
+
#
|
|
136
|
+
# @return [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::RemainingEmployeeAction, nil]
|
|
137
|
+
optional :remaining_employee_action,
|
|
138
|
+
enum: -> { VitableConnect::EmployerSubmitPayrollAccessSetupParams::RemainingEmployeeAction },
|
|
139
|
+
nil?: true
|
|
140
|
+
|
|
141
|
+
# @!attribute same_payroll_covers_other_eins
|
|
142
|
+
#
|
|
143
|
+
# @return [Boolean, nil]
|
|
144
|
+
optional :same_payroll_covers_other_eins, VitableConnect::Internal::Type::Boolean, nil?: true
|
|
145
|
+
|
|
146
|
+
# @!attribute username
|
|
147
|
+
#
|
|
148
|
+
# @return [String, nil]
|
|
149
|
+
optional :username, String, nil?: true
|
|
150
|
+
|
|
151
|
+
# @!method initialize(employer_id:, access_method:, all_benefit_eligible_employees_present:, classifications_accurate:, employees_in_payroll_acknowledged:, has_additional_payroll_system:, is_controlled_group:, payroll_data_impacts_eligibility_acknowledged:, additional_access_method: nil, additional_integration_confirmed: nil, additional_login_url: nil, additional_password: nil, additional_phone: nil, additional_username: nil, classification_correction_source: nil, integration_confirmed: nil, login_url: nil, misclassified_employee_names: nil, missing_employee_resolution: nil, password: nil, phone: nil, remaining_employee_action: nil, same_payroll_covers_other_eins: nil, username: nil, request_options: {})
|
|
152
|
+
# Some parameter documentations has been truncated, see
|
|
153
|
+
# {VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams} for more
|
|
154
|
+
# details.
|
|
155
|
+
#
|
|
156
|
+
# @param employer_id [String] Unique employer identifier (empr\_\*)
|
|
157
|
+
#
|
|
158
|
+
# @param access_method [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::AccessMethod] - `SELF_SETUP` - SELF_SETUP
|
|
159
|
+
#
|
|
160
|
+
# @param all_benefit_eligible_employees_present [Boolean]
|
|
161
|
+
#
|
|
162
|
+
# @param classifications_accurate [Boolean]
|
|
163
|
+
#
|
|
164
|
+
# @param employees_in_payroll_acknowledged [Boolean]
|
|
165
|
+
#
|
|
166
|
+
# @param has_additional_payroll_system [Boolean]
|
|
167
|
+
#
|
|
168
|
+
# @param is_controlled_group [Boolean]
|
|
169
|
+
#
|
|
170
|
+
# @param payroll_data_impacts_eligibility_acknowledged [Boolean]
|
|
171
|
+
#
|
|
172
|
+
# @param additional_access_method [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::AdditionalAccessMethod, nil] - `SELF_SETUP` - SELF_SETUP
|
|
173
|
+
#
|
|
174
|
+
# @param additional_integration_confirmed [Boolean, nil]
|
|
175
|
+
#
|
|
176
|
+
# @param additional_login_url [String, nil]
|
|
177
|
+
#
|
|
178
|
+
# @param additional_password [String, nil]
|
|
179
|
+
#
|
|
180
|
+
# @param additional_phone [String, nil]
|
|
181
|
+
#
|
|
182
|
+
# @param additional_username [String, nil]
|
|
183
|
+
#
|
|
184
|
+
# @param classification_correction_source [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::ClassificationCorrectionSource, nil] - `ENTER_NAMES` - ENTER_NAMES
|
|
185
|
+
#
|
|
186
|
+
# @param integration_confirmed [Boolean, nil]
|
|
187
|
+
#
|
|
188
|
+
# @param login_url [String, nil]
|
|
189
|
+
#
|
|
190
|
+
# @param misclassified_employee_names [Array<String>]
|
|
191
|
+
#
|
|
192
|
+
# @param missing_employee_resolution [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::MissingEmployeeResolution, nil] - `EMAIL_CENSUS` - EMAIL_CENSUS
|
|
193
|
+
#
|
|
194
|
+
# @param password [String, nil]
|
|
195
|
+
#
|
|
196
|
+
# @param phone [String, nil]
|
|
197
|
+
#
|
|
198
|
+
# @param remaining_employee_action [Symbol, VitableConnect::Models::EmployerSubmitPayrollAccessSetupParams::RemainingEmployeeAction, nil] - `VITABLE_UPDATE` - VITABLE_UPDATE
|
|
199
|
+
#
|
|
200
|
+
# @param same_payroll_covers_other_eins [Boolean, nil]
|
|
201
|
+
#
|
|
202
|
+
# @param username [String, nil]
|
|
203
|
+
#
|
|
204
|
+
# @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
|
|
205
|
+
|
|
206
|
+
# - `SELF_SETUP` - SELF_SETUP
|
|
207
|
+
# - `NEEDS_HELP` - NEEDS_HELP
|
|
208
|
+
module AccessMethod
|
|
209
|
+
extend VitableConnect::Internal::Type::Enum
|
|
210
|
+
|
|
211
|
+
SELF_SETUP = :SELF_SETUP
|
|
212
|
+
NEEDS_HELP = :NEEDS_HELP
|
|
213
|
+
|
|
214
|
+
# @!method self.values
|
|
215
|
+
# @return [Array<Symbol>]
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# - `SELF_SETUP` - SELF_SETUP
|
|
219
|
+
# - `NEEDS_HELP` - NEEDS_HELP
|
|
220
|
+
module AdditionalAccessMethod
|
|
221
|
+
extend VitableConnect::Internal::Type::Enum
|
|
222
|
+
|
|
223
|
+
SELF_SETUP = :SELF_SETUP
|
|
224
|
+
NEEDS_HELP = :NEEDS_HELP
|
|
225
|
+
|
|
226
|
+
# @!method self.values
|
|
227
|
+
# @return [Array<Symbol>]
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# - `ENTER_NAMES` - ENTER_NAMES
|
|
231
|
+
# - `EMAIL_LIST` - EMAIL_LIST
|
|
232
|
+
module ClassificationCorrectionSource
|
|
233
|
+
extend VitableConnect::Internal::Type::Enum
|
|
234
|
+
|
|
235
|
+
ENTER_NAMES = :ENTER_NAMES
|
|
236
|
+
EMAIL_LIST = :EMAIL_LIST
|
|
237
|
+
|
|
238
|
+
# @!method self.values
|
|
239
|
+
# @return [Array<Symbol>]
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
# - `EMAIL_CENSUS` - EMAIL_CENSUS
|
|
243
|
+
# - `SECOND_SYSTEM_ACCESS` - SECOND_SYSTEM_ACCESS
|
|
244
|
+
module MissingEmployeeResolution
|
|
245
|
+
extend VitableConnect::Internal::Type::Enum
|
|
246
|
+
|
|
247
|
+
EMAIL_CENSUS = :EMAIL_CENSUS
|
|
248
|
+
SECOND_SYSTEM_ACCESS = :SECOND_SYSTEM_ACCESS
|
|
249
|
+
|
|
250
|
+
# @!method self.values
|
|
251
|
+
# @return [Array<Symbol>]
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
# - `VITABLE_UPDATE` - VITABLE_UPDATE
|
|
255
|
+
# - `EMPLOYER_UPDATE` - EMPLOYER_UPDATE
|
|
256
|
+
module RemainingEmployeeAction
|
|
257
|
+
extend VitableConnect::Internal::Type::Enum
|
|
258
|
+
|
|
259
|
+
VITABLE_UPDATE = :VITABLE_UPDATE
|
|
260
|
+
EMPLOYER_UPDATE = :EMPLOYER_UPDATE
|
|
261
|
+
|
|
262
|
+
# @!method self.values
|
|
263
|
+
# @return [Array<Symbol>]
|
|
264
|
+
end
|
|
265
|
+
end
|
|
266
|
+
end
|
|
267
|
+
end
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Employers#submit_payroll_access_setup
|
|
6
|
+
class EmployerSubmitPayrollAccessSetupResponse < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [VitableConnect::Models::EmployerSubmitPayrollAccessSetupResponse::Data]
|
|
10
|
+
required :data, -> { VitableConnect::Models::EmployerSubmitPayrollAccessSetupResponse::Data }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(data:)
|
|
13
|
+
# Response containing a single payroll access setup status resource.
|
|
14
|
+
#
|
|
15
|
+
# @param data [VitableConnect::Models::EmployerSubmitPayrollAccessSetupResponse::Data]
|
|
16
|
+
|
|
17
|
+
# @see VitableConnect::Models::EmployerSubmitPayrollAccessSetupResponse#data
|
|
18
|
+
class Data < VitableConnect::Internal::Type::BaseModel
|
|
19
|
+
# @!attribute completed
|
|
20
|
+
#
|
|
21
|
+
# @return [Boolean]
|
|
22
|
+
required :completed, VitableConnect::Internal::Type::Boolean
|
|
23
|
+
|
|
24
|
+
# @!attribute submitted_at
|
|
25
|
+
#
|
|
26
|
+
# @return [Time, nil]
|
|
27
|
+
required :submitted_at, Time, nil?: true
|
|
28
|
+
|
|
29
|
+
# @!method initialize(completed:, submitted_at:)
|
|
30
|
+
# @param completed [Boolean]
|
|
31
|
+
# @param submitted_at [Time, nil]
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Employers#update
|
|
6
|
+
class EmployerUpdateParams < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
extend VitableConnect::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include VitableConnect::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute employer_id
|
|
11
|
+
# Unique employer identifier (empr\_\*)
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :employer_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute active
|
|
17
|
+
# Whether the employer is active
|
|
18
|
+
#
|
|
19
|
+
# @return [Boolean, nil]
|
|
20
|
+
optional :active, VitableConnect::Internal::Type::Boolean, nil?: true
|
|
21
|
+
|
|
22
|
+
# @!attribute address
|
|
23
|
+
# Employer address
|
|
24
|
+
#
|
|
25
|
+
# @return [VitableConnect::Models::EmployerUpdateParams::Address, nil]
|
|
26
|
+
optional :address, -> { VitableConnect::EmployerUpdateParams::Address }, nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute legal_name
|
|
29
|
+
# Legal business name
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :legal_name, String, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute name
|
|
35
|
+
# Employer display name
|
|
36
|
+
#
|
|
37
|
+
# @return [String, nil]
|
|
38
|
+
optional :name, String, nil?: true
|
|
39
|
+
|
|
40
|
+
# @!method initialize(employer_id:, active: nil, address: nil, legal_name: nil, name: nil, request_options: {})
|
|
41
|
+
# @param employer_id [String] Unique employer identifier (empr\_\*)
|
|
42
|
+
#
|
|
43
|
+
# @param active [Boolean, nil] Whether the employer is active
|
|
44
|
+
#
|
|
45
|
+
# @param address [VitableConnect::Models::EmployerUpdateParams::Address, nil] Employer address
|
|
46
|
+
#
|
|
47
|
+
# @param legal_name [String, nil] Legal business name
|
|
48
|
+
#
|
|
49
|
+
# @param name [String, nil] Employer display name
|
|
50
|
+
#
|
|
51
|
+
# @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
|
|
52
|
+
|
|
53
|
+
class Address < VitableConnect::Internal::Type::BaseModel
|
|
54
|
+
# @!attribute address_line_1
|
|
55
|
+
# Primary street address
|
|
56
|
+
#
|
|
57
|
+
# @return [String]
|
|
58
|
+
required :address_line_1, String
|
|
59
|
+
|
|
60
|
+
# @!attribute city
|
|
61
|
+
# City name
|
|
62
|
+
#
|
|
63
|
+
# @return [String]
|
|
64
|
+
required :city, String
|
|
65
|
+
|
|
66
|
+
# @!attribute state
|
|
67
|
+
# Two-letter state code
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
required :state, String
|
|
71
|
+
|
|
72
|
+
# @!attribute zipcode
|
|
73
|
+
# ZIP code
|
|
74
|
+
#
|
|
75
|
+
# @return [String]
|
|
76
|
+
required :zipcode, String
|
|
77
|
+
|
|
78
|
+
# @!attribute address_line_2
|
|
79
|
+
# Secondary street address
|
|
80
|
+
#
|
|
81
|
+
# @return [String, nil]
|
|
82
|
+
optional :address_line_2, String, nil?: true
|
|
83
|
+
|
|
84
|
+
# @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
|
|
85
|
+
# Employer address
|
|
86
|
+
#
|
|
87
|
+
# @param address_line_1 [String] Primary street address
|
|
88
|
+
#
|
|
89
|
+
# @param city [String] City name
|
|
90
|
+
#
|
|
91
|
+
# @param state [String] Two-letter state code
|
|
92
|
+
#
|
|
93
|
+
# @param zipcode [String] ZIP code
|
|
94
|
+
#
|
|
95
|
+
# @param address_line_2 [String, nil] Secondary street address
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
end
|
|
@@ -14,10 +14,10 @@ module VitableConnect
|
|
|
14
14
|
required :employer_id, String
|
|
15
15
|
|
|
16
16
|
# @!attribute pay_frequency
|
|
17
|
-
# - `weekly` -
|
|
18
|
-
# - `bi_weekly` -
|
|
19
|
-
# - `semi_monthly` -
|
|
20
|
-
# - `monthly` -
|
|
17
|
+
# - `weekly` - Weekly
|
|
18
|
+
# - `bi_weekly` - Bi Weekly
|
|
19
|
+
# - `semi_monthly` - Semi Monthly
|
|
20
|
+
# - `monthly` - Monthly
|
|
21
21
|
#
|
|
22
22
|
# @return [Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency]
|
|
23
23
|
required :pay_frequency, enum: -> { VitableConnect::EmployerUpdateSettingsParams::PayFrequency }
|
|
@@ -28,14 +28,14 @@ module VitableConnect
|
|
|
28
28
|
#
|
|
29
29
|
# @param employer_id [String] Unique employer identifier (empr\_\*)
|
|
30
30
|
#
|
|
31
|
-
# @param pay_frequency [Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency] - `weekly` -
|
|
31
|
+
# @param pay_frequency [Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency] - `weekly` - Weekly
|
|
32
32
|
#
|
|
33
33
|
# @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
|
|
34
34
|
|
|
35
|
-
# - `weekly` -
|
|
36
|
-
# - `bi_weekly` -
|
|
37
|
-
# - `semi_monthly` -
|
|
38
|
-
# - `monthly` -
|
|
35
|
+
# - `weekly` - Weekly
|
|
36
|
+
# - `bi_weekly` - Bi Weekly
|
|
37
|
+
# - `semi_monthly` - Semi Monthly
|
|
38
|
+
# - `monthly` - Monthly
|
|
39
39
|
module PayFrequency
|
|
40
40
|
extend VitableConnect::Internal::Type::Enum
|
|
41
41
|
|