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,128 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Members#retrieve_household
|
|
6
|
+
class MemberRetrieveHouseholdResponse < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [Array<VitableConnect::Models::MemberRetrieveHouseholdResponse::Data>]
|
|
10
|
+
required :data,
|
|
11
|
+
-> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Models::MemberRetrieveHouseholdResponse::Data] }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data:)
|
|
14
|
+
# Unpaginated `{"data": [...]}` list of the members of a member's household.
|
|
15
|
+
#
|
|
16
|
+
# @param data [Array<VitableConnect::Models::MemberRetrieveHouseholdResponse::Data>]
|
|
17
|
+
|
|
18
|
+
class Data < VitableConnect::Internal::Type::BaseModel
|
|
19
|
+
# @!attribute date_of_birth
|
|
20
|
+
# Date of birth (YYYY-MM-DD)
|
|
21
|
+
#
|
|
22
|
+
# @return [Date]
|
|
23
|
+
required :date_of_birth, Date
|
|
24
|
+
|
|
25
|
+
# @!attribute first_name
|
|
26
|
+
# Household member's first name
|
|
27
|
+
#
|
|
28
|
+
# @return [String]
|
|
29
|
+
required :first_name, String
|
|
30
|
+
|
|
31
|
+
# @!attribute household_admin_in
|
|
32
|
+
# Whether this participant is a household admin (the account holder always is)
|
|
33
|
+
#
|
|
34
|
+
# @return [Boolean]
|
|
35
|
+
required :household_admin_in, VitableConnect::Internal::Type::Boolean
|
|
36
|
+
|
|
37
|
+
# @!attribute last_name
|
|
38
|
+
# Household member's last name
|
|
39
|
+
#
|
|
40
|
+
# @return [String]
|
|
41
|
+
required :last_name, String
|
|
42
|
+
|
|
43
|
+
# @!attribute member_type
|
|
44
|
+
# - `Account Holder` - Account Holder
|
|
45
|
+
# - `Dependent` - Dependent
|
|
46
|
+
# - `Inactive` - Inactive
|
|
47
|
+
#
|
|
48
|
+
# @return [Symbol, VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType]
|
|
49
|
+
required :member_type,
|
|
50
|
+
enum: -> { VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType }
|
|
51
|
+
|
|
52
|
+
# @!attribute relationship
|
|
53
|
+
# - `Child` - Child
|
|
54
|
+
# - `Spouse` - Spouse
|
|
55
|
+
# - `Roommate` - Roommate
|
|
56
|
+
# - `Other` - Other
|
|
57
|
+
#
|
|
58
|
+
# @return [Symbol, VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship, nil]
|
|
59
|
+
optional :relationship,
|
|
60
|
+
enum: -> { VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship },
|
|
61
|
+
nil?: true
|
|
62
|
+
|
|
63
|
+
response_only do
|
|
64
|
+
# @!attribute member_id
|
|
65
|
+
# Member identifier with 'mbr\_' prefix
|
|
66
|
+
#
|
|
67
|
+
# @return [String]
|
|
68
|
+
required :member_id, String
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# @!method initialize(date_of_birth:, first_name:, household_admin_in:, last_name:, member_id:, member_type:, relationship: nil)
|
|
72
|
+
# Some parameter documentations has been truncated, see
|
|
73
|
+
# {VitableConnect::Models::MemberRetrieveHouseholdResponse::Data} for more
|
|
74
|
+
# details.
|
|
75
|
+
#
|
|
76
|
+
# Wire serializer for :class:`HouseholdMemberDTO` (one household participant).
|
|
77
|
+
#
|
|
78
|
+
# @param date_of_birth [Date] Date of birth (YYYY-MM-DD)
|
|
79
|
+
#
|
|
80
|
+
# @param first_name [String] Household member's first name
|
|
81
|
+
#
|
|
82
|
+
# @param household_admin_in [Boolean] Whether this participant is a household admin (the account holder always is)
|
|
83
|
+
#
|
|
84
|
+
# @param last_name [String] Household member's last name
|
|
85
|
+
#
|
|
86
|
+
# @param member_id [String] Member identifier with 'mbr\_' prefix
|
|
87
|
+
#
|
|
88
|
+
# @param member_type [Symbol, VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType] - `Account Holder` - Account Holder
|
|
89
|
+
#
|
|
90
|
+
# @param relationship [Symbol, VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship, nil] - `Child` - Child
|
|
91
|
+
|
|
92
|
+
# - `Account Holder` - Account Holder
|
|
93
|
+
# - `Dependent` - Dependent
|
|
94
|
+
# - `Inactive` - Inactive
|
|
95
|
+
#
|
|
96
|
+
# @see VitableConnect::Models::MemberRetrieveHouseholdResponse::Data#member_type
|
|
97
|
+
module MemberType
|
|
98
|
+
extend VitableConnect::Internal::Type::Enum
|
|
99
|
+
|
|
100
|
+
ACCOUNT_HOLDER = :"Account Holder"
|
|
101
|
+
DEPENDENT = :Dependent
|
|
102
|
+
INACTIVE = :Inactive
|
|
103
|
+
|
|
104
|
+
# @!method self.values
|
|
105
|
+
# @return [Array<Symbol>]
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# - `Child` - Child
|
|
109
|
+
# - `Spouse` - Spouse
|
|
110
|
+
# - `Roommate` - Roommate
|
|
111
|
+
# - `Other` - Other
|
|
112
|
+
#
|
|
113
|
+
# @see VitableConnect::Models::MemberRetrieveHouseholdResponse::Data#relationship
|
|
114
|
+
module Relationship
|
|
115
|
+
extend VitableConnect::Internal::Type::Enum
|
|
116
|
+
|
|
117
|
+
CHILD = :Child
|
|
118
|
+
SPOUSE = :Spouse
|
|
119
|
+
ROOMMATE = :Roommate
|
|
120
|
+
OTHER = :Other
|
|
121
|
+
|
|
122
|
+
# @!method self.values
|
|
123
|
+
# @return [Array<Symbol>]
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
|
127
|
+
end
|
|
128
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Members#retrieve
|
|
6
|
+
class MemberRetrieveParams < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
extend VitableConnect::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include VitableConnect::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute member_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :member_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(member_id:, request_options: {})
|
|
16
|
+
# @param member_id [String]
|
|
17
|
+
# @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Members#retrieve
|
|
6
|
+
class MemberRetrieveResponse < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# A member's profile: identity, contact details, address, demographics, and
|
|
9
|
+
# onboarding status.
|
|
10
|
+
#
|
|
11
|
+
# @return [VitableConnect::Models::MemberRetrieveResponse::Data]
|
|
12
|
+
required :data, -> { VitableConnect::Models::MemberRetrieveResponse::Data }
|
|
13
|
+
|
|
14
|
+
# @!method initialize(data:)
|
|
15
|
+
# Some parameter documentations has been truncated, see
|
|
16
|
+
# {VitableConnect::Models::MemberRetrieveResponse} for more details.
|
|
17
|
+
#
|
|
18
|
+
# Response containing a single member resource.
|
|
19
|
+
#
|
|
20
|
+
# @param data [VitableConnect::Models::MemberRetrieveResponse::Data] A member's profile: identity, contact details, address, demographics, and onboar
|
|
21
|
+
|
|
22
|
+
# @see VitableConnect::Models::MemberRetrieveResponse#data
|
|
23
|
+
class Data < VitableConnect::Internal::Type::BaseModel
|
|
24
|
+
# @!attribute age
|
|
25
|
+
# Member's age in years, derived from date of birth
|
|
26
|
+
#
|
|
27
|
+
# @return [Integer]
|
|
28
|
+
required :age, Integer
|
|
29
|
+
|
|
30
|
+
# @!attribute date_of_birth
|
|
31
|
+
# Date of birth (YYYY-MM-DD)
|
|
32
|
+
#
|
|
33
|
+
# @return [Date]
|
|
34
|
+
required :date_of_birth, Date
|
|
35
|
+
|
|
36
|
+
# @!attribute first_name
|
|
37
|
+
# Member's legal first name
|
|
38
|
+
#
|
|
39
|
+
# @return [String]
|
|
40
|
+
required :first_name, String
|
|
41
|
+
|
|
42
|
+
# @!attribute last_name
|
|
43
|
+
# Member's legal last name
|
|
44
|
+
#
|
|
45
|
+
# @return [String]
|
|
46
|
+
required :last_name, String
|
|
47
|
+
|
|
48
|
+
# @!attribute address
|
|
49
|
+
# Member's residential address
|
|
50
|
+
#
|
|
51
|
+
# @return [VitableConnect::Models::MemberRetrieveResponse::Data::Address, nil]
|
|
52
|
+
optional :address, -> { VitableConnect::Models::MemberRetrieveResponse::Data::Address }, nil?: true
|
|
53
|
+
|
|
54
|
+
# @!attribute email
|
|
55
|
+
# Email address
|
|
56
|
+
#
|
|
57
|
+
# @return [String, nil]
|
|
58
|
+
optional :email, String, nil?: true
|
|
59
|
+
|
|
60
|
+
# @!attribute phone
|
|
61
|
+
# Phone number (10-digit US domestic string)
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :phone, String, nil?: true
|
|
65
|
+
|
|
66
|
+
# @!attribute preferred_language
|
|
67
|
+
# Member's preferred language code (e.g., en, es)
|
|
68
|
+
#
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
optional :preferred_language, String, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!attribute sex_at_birth
|
|
73
|
+
# Sex assigned at birth, if provided
|
|
74
|
+
#
|
|
75
|
+
# @return [String, nil]
|
|
76
|
+
optional :sex_at_birth, String, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute tobacco_status
|
|
79
|
+
# Whether the member uses tobacco, if known
|
|
80
|
+
#
|
|
81
|
+
# @return [Boolean, nil]
|
|
82
|
+
optional :tobacco_status, VitableConnect::Internal::Type::Boolean, nil?: true
|
|
83
|
+
|
|
84
|
+
response_only do
|
|
85
|
+
# @!attribute id
|
|
86
|
+
# Unique member identifier with 'mbr\_' prefix
|
|
87
|
+
#
|
|
88
|
+
# @return [String]
|
|
89
|
+
required :id, String
|
|
90
|
+
|
|
91
|
+
# @!attribute name
|
|
92
|
+
# Member's full name
|
|
93
|
+
#
|
|
94
|
+
# @return [String]
|
|
95
|
+
required :name, String
|
|
96
|
+
|
|
97
|
+
# @!attribute status
|
|
98
|
+
# Member profile status (onboarded or pending onboarding)
|
|
99
|
+
#
|
|
100
|
+
# @return [Symbol, VitableConnect::Models::MemberRetrieveResponse::Data::Status]
|
|
101
|
+
required :status, enum: -> { VitableConnect::Models::MemberRetrieveResponse::Data::Status }
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# @!method initialize(id:, age:, date_of_birth:, first_name:, last_name:, name:, status:, address: nil, email: nil, phone: nil, preferred_language: nil, sex_at_birth: nil, tobacco_status: nil)
|
|
105
|
+
# A member's profile: identity, contact details, address, demographics, and
|
|
106
|
+
# onboarding status.
|
|
107
|
+
#
|
|
108
|
+
# @param id [String] Unique member identifier with 'mbr\_' prefix
|
|
109
|
+
#
|
|
110
|
+
# @param age [Integer] Member's age in years, derived from date of birth
|
|
111
|
+
#
|
|
112
|
+
# @param date_of_birth [Date] Date of birth (YYYY-MM-DD)
|
|
113
|
+
#
|
|
114
|
+
# @param first_name [String] Member's legal first name
|
|
115
|
+
#
|
|
116
|
+
# @param last_name [String] Member's legal last name
|
|
117
|
+
#
|
|
118
|
+
# @param name [String] Member's full name
|
|
119
|
+
#
|
|
120
|
+
# @param status [Symbol, VitableConnect::Models::MemberRetrieveResponse::Data::Status] Member profile status (onboarded or pending onboarding)
|
|
121
|
+
#
|
|
122
|
+
# @param address [VitableConnect::Models::MemberRetrieveResponse::Data::Address, nil] Member's residential address
|
|
123
|
+
#
|
|
124
|
+
# @param email [String, nil] Email address
|
|
125
|
+
#
|
|
126
|
+
# @param phone [String, nil] Phone number (10-digit US domestic string)
|
|
127
|
+
#
|
|
128
|
+
# @param preferred_language [String, nil] Member's preferred language code (e.g., en, es)
|
|
129
|
+
#
|
|
130
|
+
# @param sex_at_birth [String, nil] Sex assigned at birth, if provided
|
|
131
|
+
#
|
|
132
|
+
# @param tobacco_status [Boolean, nil] Whether the member uses tobacco, if known
|
|
133
|
+
|
|
134
|
+
# Member profile status (onboarded or pending onboarding)
|
|
135
|
+
#
|
|
136
|
+
# @see VitableConnect::Models::MemberRetrieveResponse::Data#status
|
|
137
|
+
module Status
|
|
138
|
+
extend VitableConnect::Internal::Type::Enum
|
|
139
|
+
|
|
140
|
+
ONBOARDED = :onboarded
|
|
141
|
+
PENDING_ONBOARDING = :pending_onboarding
|
|
142
|
+
|
|
143
|
+
# @!method self.values
|
|
144
|
+
# @return [Array<Symbol>]
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# @see VitableConnect::Models::MemberRetrieveResponse::Data#address
|
|
148
|
+
class Address < VitableConnect::Internal::Type::BaseModel
|
|
149
|
+
# @!attribute address_line_1
|
|
150
|
+
# Primary street address
|
|
151
|
+
#
|
|
152
|
+
# @return [String]
|
|
153
|
+
required :address_line_1, String
|
|
154
|
+
|
|
155
|
+
# @!attribute city
|
|
156
|
+
# City name
|
|
157
|
+
#
|
|
158
|
+
# @return [String]
|
|
159
|
+
required :city, String
|
|
160
|
+
|
|
161
|
+
# @!attribute state
|
|
162
|
+
# Two-letter state code (e.g., CA, NY)
|
|
163
|
+
#
|
|
164
|
+
# @return [String]
|
|
165
|
+
required :state, String
|
|
166
|
+
|
|
167
|
+
# @!attribute zipcode
|
|
168
|
+
# ZIP code (5 or 9 digit)
|
|
169
|
+
#
|
|
170
|
+
# @return [String]
|
|
171
|
+
required :zipcode, String
|
|
172
|
+
|
|
173
|
+
# @!attribute address_line_2
|
|
174
|
+
# Secondary street address (apt, suite, etc.)
|
|
175
|
+
#
|
|
176
|
+
# @return [String, nil]
|
|
177
|
+
optional :address_line_2, String, nil?: true
|
|
178
|
+
|
|
179
|
+
# @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
|
|
180
|
+
# Member's residential address
|
|
181
|
+
#
|
|
182
|
+
# @param address_line_1 [String] Primary street address
|
|
183
|
+
#
|
|
184
|
+
# @param city [String] City name
|
|
185
|
+
#
|
|
186
|
+
# @param state [String] Two-letter state code (e.g., CA, NY)
|
|
187
|
+
#
|
|
188
|
+
# @param zipcode [String] ZIP code (5 or 9 digit)
|
|
189
|
+
#
|
|
190
|
+
# @param address_line_2 [String, nil] Secondary street address (apt, suite, etc.)
|
|
191
|
+
end
|
|
192
|
+
end
|
|
193
|
+
end
|
|
194
|
+
end
|
|
195
|
+
end
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Organizations#create
|
|
6
|
+
class OrganizationCreateParams < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
extend VitableConnect::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include VitableConnect::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute name
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :name, String
|
|
14
|
+
|
|
15
|
+
# @!attribute type
|
|
16
|
+
# - `BROKERAGE` - BROKERAGE
|
|
17
|
+
# - `TPA` - TPA
|
|
18
|
+
# - `GENERAL_AGENT` - GENERAL_AGENT
|
|
19
|
+
# - `CHANNEL_PARTNER` - CHANNEL_PARTNER
|
|
20
|
+
# - `CONSULTING_FIRM` - CONSULTING_FIRM
|
|
21
|
+
# - `API_PLATFORM` - API_PLATFORM
|
|
22
|
+
#
|
|
23
|
+
# @return [Symbol, VitableConnect::Models::OrganizationCreateParams::Type, nil]
|
|
24
|
+
optional :type, enum: -> { VitableConnect::OrganizationCreateParams::Type }, nil?: true
|
|
25
|
+
|
|
26
|
+
# @!method initialize(name:, type: nil, request_options: {})
|
|
27
|
+
# Some parameter documentations has been truncated, see
|
|
28
|
+
# {VitableConnect::Models::OrganizationCreateParams} for more details.
|
|
29
|
+
#
|
|
30
|
+
# @param name [String]
|
|
31
|
+
#
|
|
32
|
+
# @param type [Symbol, VitableConnect::Models::OrganizationCreateParams::Type, nil] - `BROKERAGE` - BROKERAGE
|
|
33
|
+
#
|
|
34
|
+
# @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
|
|
35
|
+
|
|
36
|
+
# - `BROKERAGE` - BROKERAGE
|
|
37
|
+
# - `TPA` - TPA
|
|
38
|
+
# - `GENERAL_AGENT` - GENERAL_AGENT
|
|
39
|
+
# - `CHANNEL_PARTNER` - CHANNEL_PARTNER
|
|
40
|
+
# - `CONSULTING_FIRM` - CONSULTING_FIRM
|
|
41
|
+
# - `API_PLATFORM` - API_PLATFORM
|
|
42
|
+
module Type
|
|
43
|
+
extend VitableConnect::Internal::Type::Enum
|
|
44
|
+
|
|
45
|
+
BROKERAGE = :BROKERAGE
|
|
46
|
+
TPA = :TPA
|
|
47
|
+
GENERAL_AGENT = :GENERAL_AGENT
|
|
48
|
+
CHANNEL_PARTNER = :CHANNEL_PARTNER
|
|
49
|
+
CONSULTING_FIRM = :CONSULTING_FIRM
|
|
50
|
+
API_PLATFORM = :API_PLATFORM
|
|
51
|
+
|
|
52
|
+
# @!method self.values
|
|
53
|
+
# @return [Array<Symbol>]
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Organizations#create
|
|
6
|
+
class OrganizationCreateResponse < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# Prefixed organization identifier (`org_<base64-encoded-uuid>`).
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute idp_org_id
|
|
14
|
+
# IdP-issued tenant id (WorkOS org id).
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
required :idp_org_id, String, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute idp_provider
|
|
20
|
+
# - `workos` - WorkOS
|
|
21
|
+
# - `vitable` - Vitable
|
|
22
|
+
#
|
|
23
|
+
# @return [Symbol, VitableConnect::Models::OrganizationCreateResponse::IdpProvider, nil]
|
|
24
|
+
required :idp_provider,
|
|
25
|
+
enum: -> { VitableConnect::Models::OrganizationCreateResponse::IdpProvider },
|
|
26
|
+
nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute name
|
|
29
|
+
# Human-readable organization name.
|
|
30
|
+
#
|
|
31
|
+
# @return [String]
|
|
32
|
+
required :name, String
|
|
33
|
+
|
|
34
|
+
# @!attribute super_in
|
|
35
|
+
# Whether this organization reads across every organization.
|
|
36
|
+
#
|
|
37
|
+
# @return [Boolean]
|
|
38
|
+
required :super_in, VitableConnect::Internal::Type::Boolean
|
|
39
|
+
|
|
40
|
+
# @!attribute type
|
|
41
|
+
# - `BROKERAGE` - Brokerage
|
|
42
|
+
# - `TPA` - TPA
|
|
43
|
+
# - `GENERAL_AGENT` - General Agent
|
|
44
|
+
# - `CHANNEL_PARTNER` - Channel Partner
|
|
45
|
+
# - `CONSULTING_FIRM` - Consulting Firm
|
|
46
|
+
# - `API_PLATFORM` - API Platform
|
|
47
|
+
#
|
|
48
|
+
# @return [Symbol, VitableConnect::Models::OrganizationCreateResponse::Type, nil]
|
|
49
|
+
required :type, enum: -> { VitableConnect::Models::OrganizationCreateResponse::Type }, nil?: true
|
|
50
|
+
|
|
51
|
+
# @!method initialize(id:, idp_org_id:, idp_provider:, name:, super_in:, type:)
|
|
52
|
+
# Some parameter documentations has been truncated, see
|
|
53
|
+
# {VitableConnect::Models::OrganizationCreateResponse} for more details.
|
|
54
|
+
#
|
|
55
|
+
# @param id [String] Prefixed organization identifier (`org_<base64-encoded-uuid>`).
|
|
56
|
+
#
|
|
57
|
+
# @param idp_org_id [String, nil] IdP-issued tenant id (WorkOS org id).
|
|
58
|
+
#
|
|
59
|
+
# @param idp_provider [Symbol, VitableConnect::Models::OrganizationCreateResponse::IdpProvider, nil] - `workos` - WorkOS
|
|
60
|
+
#
|
|
61
|
+
# @param name [String] Human-readable organization name.
|
|
62
|
+
#
|
|
63
|
+
# @param super_in [Boolean] Whether this organization reads across every organization.
|
|
64
|
+
#
|
|
65
|
+
# @param type [Symbol, VitableConnect::Models::OrganizationCreateResponse::Type, nil] - `BROKERAGE` - Brokerage
|
|
66
|
+
|
|
67
|
+
# - `workos` - WorkOS
|
|
68
|
+
# - `vitable` - Vitable
|
|
69
|
+
#
|
|
70
|
+
# @see VitableConnect::Models::OrganizationCreateResponse#idp_provider
|
|
71
|
+
module IdpProvider
|
|
72
|
+
extend VitableConnect::Internal::Type::Enum
|
|
73
|
+
|
|
74
|
+
WORKOS = :workos
|
|
75
|
+
VITABLE = :vitable
|
|
76
|
+
|
|
77
|
+
# @!method self.values
|
|
78
|
+
# @return [Array<Symbol>]
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# - `BROKERAGE` - Brokerage
|
|
82
|
+
# - `TPA` - TPA
|
|
83
|
+
# - `GENERAL_AGENT` - General Agent
|
|
84
|
+
# - `CHANNEL_PARTNER` - Channel Partner
|
|
85
|
+
# - `CONSULTING_FIRM` - Consulting Firm
|
|
86
|
+
# - `API_PLATFORM` - API Platform
|
|
87
|
+
#
|
|
88
|
+
# @see VitableConnect::Models::OrganizationCreateResponse#type
|
|
89
|
+
module Type
|
|
90
|
+
extend VitableConnect::Internal::Type::Enum
|
|
91
|
+
|
|
92
|
+
BROKERAGE = :BROKERAGE
|
|
93
|
+
TPA = :TPA
|
|
94
|
+
GENERAL_AGENT = :GENERAL_AGENT
|
|
95
|
+
CHANNEL_PARTNER = :CHANNEL_PARTNER
|
|
96
|
+
CONSULTING_FIRM = :CONSULTING_FIRM
|
|
97
|
+
API_PLATFORM = :API_PLATFORM
|
|
98
|
+
|
|
99
|
+
# @!method self.values
|
|
100
|
+
# @return [Array<Symbol>]
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Organizations#list
|
|
6
|
+
class OrganizationListParams < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
extend VitableConnect::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include VitableConnect::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module VitableConnect
|
|
4
|
+
module Models
|
|
5
|
+
# @see VitableConnect::Resources::Organizations#list
|
|
6
|
+
class OrganizationListResponse < VitableConnect::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute organizations
|
|
8
|
+
#
|
|
9
|
+
# @return [Array<VitableConnect::Models::OrganizationListResponse::Organization>]
|
|
10
|
+
required :organizations,
|
|
11
|
+
-> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Models::OrganizationListResponse::Organization] }
|
|
12
|
+
|
|
13
|
+
# @!attribute total
|
|
14
|
+
# Total number of organizations the caller belongs to.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :total, Integer
|
|
18
|
+
|
|
19
|
+
# @!method initialize(organizations:, total:)
|
|
20
|
+
# Envelope for the caller's organization memberships (paginated).
|
|
21
|
+
#
|
|
22
|
+
# @param organizations [Array<VitableConnect::Models::OrganizationListResponse::Organization>]
|
|
23
|
+
#
|
|
24
|
+
# @param total [Integer] Total number of organizations the caller belongs to.
|
|
25
|
+
|
|
26
|
+
class Organization < VitableConnect::Internal::Type::BaseModel
|
|
27
|
+
# @!attribute id
|
|
28
|
+
# Prefixed organization identifier (`org_<base64-encoded-uuid>`).
|
|
29
|
+
#
|
|
30
|
+
# @return [String]
|
|
31
|
+
required :id, String
|
|
32
|
+
|
|
33
|
+
# @!attribute idp_org_id
|
|
34
|
+
# IdP-issued tenant id (WorkOS org id).
|
|
35
|
+
#
|
|
36
|
+
# @return [String, nil]
|
|
37
|
+
required :idp_org_id, String, nil?: true
|
|
38
|
+
|
|
39
|
+
# @!attribute idp_provider
|
|
40
|
+
# - `workos` - WorkOS
|
|
41
|
+
# - `vitable` - Vitable
|
|
42
|
+
#
|
|
43
|
+
# @return [Symbol, VitableConnect::Models::OrganizationListResponse::Organization::IdpProvider, nil]
|
|
44
|
+
required :idp_provider,
|
|
45
|
+
enum: -> { VitableConnect::Models::OrganizationListResponse::Organization::IdpProvider },
|
|
46
|
+
nil?: true
|
|
47
|
+
|
|
48
|
+
# @!attribute name
|
|
49
|
+
# Human-readable organization name.
|
|
50
|
+
#
|
|
51
|
+
# @return [String]
|
|
52
|
+
required :name, String
|
|
53
|
+
|
|
54
|
+
# @!attribute super_in
|
|
55
|
+
# Whether this organization reads across every organization.
|
|
56
|
+
#
|
|
57
|
+
# @return [Boolean]
|
|
58
|
+
required :super_in, VitableConnect::Internal::Type::Boolean
|
|
59
|
+
|
|
60
|
+
# @!attribute type
|
|
61
|
+
# - `BROKERAGE` - Brokerage
|
|
62
|
+
# - `TPA` - TPA
|
|
63
|
+
# - `GENERAL_AGENT` - General Agent
|
|
64
|
+
# - `CHANNEL_PARTNER` - Channel Partner
|
|
65
|
+
# - `CONSULTING_FIRM` - Consulting Firm
|
|
66
|
+
# - `API_PLATFORM` - API Platform
|
|
67
|
+
#
|
|
68
|
+
# @return [Symbol, VitableConnect::Models::OrganizationListResponse::Organization::Type, nil]
|
|
69
|
+
required :type,
|
|
70
|
+
enum: -> { VitableConnect::Models::OrganizationListResponse::Organization::Type },
|
|
71
|
+
nil?: true
|
|
72
|
+
|
|
73
|
+
# @!method initialize(id:, idp_org_id:, idp_provider:, name:, super_in:, type:)
|
|
74
|
+
# Some parameter documentations has been truncated, see
|
|
75
|
+
# {VitableConnect::Models::OrganizationListResponse::Organization} for more
|
|
76
|
+
# details.
|
|
77
|
+
#
|
|
78
|
+
# @param id [String] Prefixed organization identifier (`org_<base64-encoded-uuid>`).
|
|
79
|
+
#
|
|
80
|
+
# @param idp_org_id [String, nil] IdP-issued tenant id (WorkOS org id).
|
|
81
|
+
#
|
|
82
|
+
# @param idp_provider [Symbol, VitableConnect::Models::OrganizationListResponse::Organization::IdpProvider, nil] - `workos` - WorkOS
|
|
83
|
+
#
|
|
84
|
+
# @param name [String] Human-readable organization name.
|
|
85
|
+
#
|
|
86
|
+
# @param super_in [Boolean] Whether this organization reads across every organization.
|
|
87
|
+
#
|
|
88
|
+
# @param type [Symbol, VitableConnect::Models::OrganizationListResponse::Organization::Type, nil] - `BROKERAGE` - Brokerage
|
|
89
|
+
|
|
90
|
+
# - `workos` - WorkOS
|
|
91
|
+
# - `vitable` - Vitable
|
|
92
|
+
#
|
|
93
|
+
# @see VitableConnect::Models::OrganizationListResponse::Organization#idp_provider
|
|
94
|
+
module IdpProvider
|
|
95
|
+
extend VitableConnect::Internal::Type::Enum
|
|
96
|
+
|
|
97
|
+
WORKOS = :workos
|
|
98
|
+
VITABLE = :vitable
|
|
99
|
+
|
|
100
|
+
# @!method self.values
|
|
101
|
+
# @return [Array<Symbol>]
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# - `BROKERAGE` - Brokerage
|
|
105
|
+
# - `TPA` - TPA
|
|
106
|
+
# - `GENERAL_AGENT` - General Agent
|
|
107
|
+
# - `CHANNEL_PARTNER` - Channel Partner
|
|
108
|
+
# - `CONSULTING_FIRM` - Consulting Firm
|
|
109
|
+
# - `API_PLATFORM` - API Platform
|
|
110
|
+
#
|
|
111
|
+
# @see VitableConnect::Models::OrganizationListResponse::Organization#type
|
|
112
|
+
module Type
|
|
113
|
+
extend VitableConnect::Internal::Type::Enum
|
|
114
|
+
|
|
115
|
+
BROKERAGE = :BROKERAGE
|
|
116
|
+
TPA = :TPA
|
|
117
|
+
GENERAL_AGENT = :GENERAL_AGENT
|
|
118
|
+
CHANNEL_PARTNER = :CHANNEL_PARTNER
|
|
119
|
+
CONSULTING_FIRM = :CONSULTING_FIRM
|
|
120
|
+
API_PLATFORM = :API_PLATFORM
|
|
121
|
+
|
|
122
|
+
# @!method self.values
|
|
123
|
+
# @return [Array<Symbol>]
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
|
127
|
+
end
|
|
128
|
+
end
|
|
@@ -20,6 +20,7 @@ module VitableConnect
|
|
|
20
20
|
# @!attribute event_name
|
|
21
21
|
# - `enrollment.accepted` - Enrollment Accepted
|
|
22
22
|
# - `enrollment.terminated` - Enrollment Terminated
|
|
23
|
+
# - `enrollment.termination_rescheduled` - Enrollment Termination Rescheduled
|
|
23
24
|
# - `enrollment.elected` - Enrollment Elected
|
|
24
25
|
# - `enrollment.granted` - Enrollment Granted
|
|
25
26
|
# - `enrollment.waived` - Enrollment Waived
|
|
@@ -27,7 +28,6 @@ module VitableConnect
|
|
|
27
28
|
# - `employee.eligibility_granted` - Employee Eligibility Granted
|
|
28
29
|
# - `employee.eligibility_terminated` - Employee Eligibility Terminated
|
|
29
30
|
# - `employee.deactivated` - Employee Deactivated
|
|
30
|
-
# - `employer.eligibility_policy_created` - Employer Eligibility Policy Created
|
|
31
31
|
# - `employee.deduction_created` - Employee Deduction Created
|
|
32
32
|
#
|
|
33
33
|
# @return [Symbol, VitableConnect::Models::WebhookEventListParams::EventName, nil]
|
|
@@ -83,6 +83,7 @@ module VitableConnect
|
|
|
83
83
|
|
|
84
84
|
# - `enrollment.accepted` - Enrollment Accepted
|
|
85
85
|
# - `enrollment.terminated` - Enrollment Terminated
|
|
86
|
+
# - `enrollment.termination_rescheduled` - Enrollment Termination Rescheduled
|
|
86
87
|
# - `enrollment.elected` - Enrollment Elected
|
|
87
88
|
# - `enrollment.granted` - Enrollment Granted
|
|
88
89
|
# - `enrollment.waived` - Enrollment Waived
|
|
@@ -90,13 +91,13 @@ module VitableConnect
|
|
|
90
91
|
# - `employee.eligibility_granted` - Employee Eligibility Granted
|
|
91
92
|
# - `employee.eligibility_terminated` - Employee Eligibility Terminated
|
|
92
93
|
# - `employee.deactivated` - Employee Deactivated
|
|
93
|
-
# - `employer.eligibility_policy_created` - Employer Eligibility Policy Created
|
|
94
94
|
# - `employee.deduction_created` - Employee Deduction Created
|
|
95
95
|
module EventName
|
|
96
96
|
extend VitableConnect::Internal::Type::Enum
|
|
97
97
|
|
|
98
98
|
ENROLLMENT_ACCEPTED = :"enrollment.accepted"
|
|
99
99
|
ENROLLMENT_TERMINATED = :"enrollment.terminated"
|
|
100
|
+
ENROLLMENT_TERMINATION_RESCHEDULED = :"enrollment.termination_rescheduled"
|
|
100
101
|
ENROLLMENT_ELECTED = :"enrollment.elected"
|
|
101
102
|
ENROLLMENT_GRANTED = :"enrollment.granted"
|
|
102
103
|
ENROLLMENT_WAIVED = :"enrollment.waived"
|
|
@@ -104,7 +105,6 @@ module VitableConnect
|
|
|
104
105
|
EMPLOYEE_ELIGIBILITY_GRANTED = :"employee.eligibility_granted"
|
|
105
106
|
EMPLOYEE_ELIGIBILITY_TERMINATED = :"employee.eligibility_terminated"
|
|
106
107
|
EMPLOYEE_DEACTIVATED = :"employee.deactivated"
|
|
107
|
-
EMPLOYER_ELIGIBILITY_POLICY_CREATED = :"employer.eligibility_policy_created"
|
|
108
108
|
EMPLOYEE_DEDUCTION_CREATED = :"employee.deduction_created"
|
|
109
109
|
|
|
110
110
|
# @!method self.values
|