vitable-connect 0.1.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.
Files changed (185) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +39 -0
  4. data/README.md +267 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/vitable_connect/client.rb +118 -0
  7. data/lib/vitable_connect/errors.rb +228 -0
  8. data/lib/vitable_connect/file_part.rb +58 -0
  9. data/lib/vitable_connect/internal/page_number_page.rb +113 -0
  10. data/lib/vitable_connect/internal/transport/base_client.rb +577 -0
  11. data/lib/vitable_connect/internal/transport/pooled_net_requester.rb +210 -0
  12. data/lib/vitable_connect/internal/type/array_of.rb +168 -0
  13. data/lib/vitable_connect/internal/type/base_model.rb +534 -0
  14. data/lib/vitable_connect/internal/type/base_page.rb +55 -0
  15. data/lib/vitable_connect/internal/type/boolean.rb +77 -0
  16. data/lib/vitable_connect/internal/type/converter.rb +327 -0
  17. data/lib/vitable_connect/internal/type/enum.rb +152 -0
  18. data/lib/vitable_connect/internal/type/file_input.rb +111 -0
  19. data/lib/vitable_connect/internal/type/hash_of.rb +188 -0
  20. data/lib/vitable_connect/internal/type/request_parameters.rb +42 -0
  21. data/lib/vitable_connect/internal/type/union.rb +245 -0
  22. data/lib/vitable_connect/internal/type/unknown.rb +81 -0
  23. data/lib/vitable_connect/internal/util.rb +951 -0
  24. data/lib/vitable_connect/internal.rb +20 -0
  25. data/lib/vitable_connect/models/auth_issue_access_token_params.rb +68 -0
  26. data/lib/vitable_connect/models/auth_issue_access_token_response.rb +70 -0
  27. data/lib/vitable_connect/models/benefit_eligibility_policy.rb +53 -0
  28. data/lib/vitable_connect/models/benefit_eligibility_policy_response.rb +18 -0
  29. data/lib/vitable_connect/models/benefit_eligibility_policy_retrieve_params.rb +22 -0
  30. data/lib/vitable_connect/models/employee.rb +244 -0
  31. data/lib/vitable_connect/models/employee_class.rb +25 -0
  32. data/lib/vitable_connect/models/employee_list_enrollments_params.rb +38 -0
  33. data/lib/vitable_connect/models/employee_retrieve_params.rb +22 -0
  34. data/lib/vitable_connect/models/employee_retrieve_response.rb +18 -0
  35. data/lib/vitable_connect/models/employer.rb +163 -0
  36. data/lib/vitable_connect/models/employer_create_benefit_eligibility_policy_params.rb +43 -0
  37. data/lib/vitable_connect/models/employer_create_params.rb +115 -0
  38. data/lib/vitable_connect/models/employer_list_employees_params.rb +38 -0
  39. data/lib/vitable_connect/models/employer_list_params.rb +30 -0
  40. data/lib/vitable_connect/models/employer_response.rb +19 -0
  41. data/lib/vitable_connect/models/employer_retrieve_params.rb +22 -0
  42. data/lib/vitable_connect/models/employer_submit_census_sync_params.rb +374 -0
  43. data/lib/vitable_connect/models/employer_submit_census_sync_response.rb +35 -0
  44. data/lib/vitable_connect/models/enrollment.rb +234 -0
  45. data/lib/vitable_connect/models/enrollment_retrieve_params.rb +22 -0
  46. data/lib/vitable_connect/models/enrollment_retrieve_response.rb +18 -0
  47. data/lib/vitable_connect/models/enrollment_status.rb +21 -0
  48. data/lib/vitable_connect/models/pagination.rb +42 -0
  49. data/lib/vitable_connect/models/type.rb +17 -0
  50. data/lib/vitable_connect/models/webhook_event.rb +62 -0
  51. data/lib/vitable_connect/models/webhook_event_list_deliveries_params.rb +20 -0
  52. data/lib/vitable_connect/models/webhook_event_list_deliveries_response.rb +92 -0
  53. data/lib/vitable_connect/models/webhook_event_list_params.rb +135 -0
  54. data/lib/vitable_connect/models/webhook_event_retrieve_params.rb +20 -0
  55. data/lib/vitable_connect/models/webhook_event_retrieve_response.rb +18 -0
  56. data/lib/vitable_connect/models.rb +95 -0
  57. data/lib/vitable_connect/request_options.rb +78 -0
  58. data/lib/vitable_connect/resources/auth.rb +41 -0
  59. data/lib/vitable_connect/resources/benefit_eligibility_policies.rb +35 -0
  60. data/lib/vitable_connect/resources/employees.rb +63 -0
  61. data/lib/vitable_connect/resources/employers.rb +184 -0
  62. data/lib/vitable_connect/resources/enrollments.rb +35 -0
  63. data/lib/vitable_connect/resources/webhook_events.rb +95 -0
  64. data/lib/vitable_connect/version.rb +5 -0
  65. data/lib/vitable_connect.rb +93 -0
  66. data/manifest.yaml +17 -0
  67. data/rbi/vitable_connect/client.rbi +88 -0
  68. data/rbi/vitable_connect/errors.rbi +205 -0
  69. data/rbi/vitable_connect/file_part.rbi +37 -0
  70. data/rbi/vitable_connect/internal/page_number_page.rbi +49 -0
  71. data/rbi/vitable_connect/internal/transport/base_client.rbi +307 -0
  72. data/rbi/vitable_connect/internal/transport/pooled_net_requester.rbi +84 -0
  73. data/rbi/vitable_connect/internal/type/array_of.rbi +108 -0
  74. data/rbi/vitable_connect/internal/type/base_model.rbi +314 -0
  75. data/rbi/vitable_connect/internal/type/base_page.rbi +43 -0
  76. data/rbi/vitable_connect/internal/type/boolean.rbi +58 -0
  77. data/rbi/vitable_connect/internal/type/converter.rbi +225 -0
  78. data/rbi/vitable_connect/internal/type/enum.rbi +82 -0
  79. data/rbi/vitable_connect/internal/type/file_input.rbi +59 -0
  80. data/rbi/vitable_connect/internal/type/hash_of.rbi +108 -0
  81. data/rbi/vitable_connect/internal/type/request_parameters.rbi +31 -0
  82. data/rbi/vitable_connect/internal/type/union.rbi +130 -0
  83. data/rbi/vitable_connect/internal/type/unknown.rbi +58 -0
  84. data/rbi/vitable_connect/internal/util.rbi +507 -0
  85. data/rbi/vitable_connect/internal.rbi +18 -0
  86. data/rbi/vitable_connect/models/auth_issue_access_token_params.rbi +147 -0
  87. data/rbi/vitable_connect/models/auth_issue_access_token_response.rbi +128 -0
  88. data/rbi/vitable_connect/models/benefit_eligibility_policy.rbi +74 -0
  89. data/rbi/vitable_connect/models/benefit_eligibility_policy_response.rbi +38 -0
  90. data/rbi/vitable_connect/models/benefit_eligibility_policy_retrieve_params.rbi +43 -0
  91. data/rbi/vitable_connect/models/employee.rbi +316 -0
  92. data/rbi/vitable_connect/models/employee_class.rbi +38 -0
  93. data/rbi/vitable_connect/models/employee_list_enrollments_params.rbi +68 -0
  94. data/rbi/vitable_connect/models/employee_retrieve_params.rbi +46 -0
  95. data/rbi/vitable_connect/models/employee_retrieve_response.rbi +32 -0
  96. data/rbi/vitable_connect/models/employer.rbi +205 -0
  97. data/rbi/vitable_connect/models/employer_create_benefit_eligibility_policy_params.rbi +64 -0
  98. data/rbi/vitable_connect/models/employer_create_params.rbi +169 -0
  99. data/rbi/vitable_connect/models/employer_list_employees_params.rbi +68 -0
  100. data/rbi/vitable_connect/models/employer_list_params.rbi +60 -0
  101. data/rbi/vitable_connect/models/employer_response.rbi +36 -0
  102. data/rbi/vitable_connect/models/employer_retrieve_params.rbi +46 -0
  103. data/rbi/vitable_connect/models/employer_submit_census_sync_params.rbi +819 -0
  104. data/rbi/vitable_connect/models/employer_submit_census_sync_response.rbi +76 -0
  105. data/rbi/vitable_connect/models/enrollment.rbi +401 -0
  106. data/rbi/vitable_connect/models/enrollment_retrieve_params.rbi +46 -0
  107. data/rbi/vitable_connect/models/enrollment_retrieve_response.rbi +34 -0
  108. data/rbi/vitable_connect/models/enrollment_status.rbi +32 -0
  109. data/rbi/vitable_connect/models/pagination.rbi +62 -0
  110. data/rbi/vitable_connect/models/type.rbi +21 -0
  111. data/rbi/vitable_connect/models/webhook_event.rbi +81 -0
  112. data/rbi/vitable_connect/models/webhook_event_list_deliveries_params.rbi +38 -0
  113. data/rbi/vitable_connect/models/webhook_event_list_deliveries_response.rbi +147 -0
  114. data/rbi/vitable_connect/models/webhook_event_list_params.rbi +307 -0
  115. data/rbi/vitable_connect/models/webhook_event_retrieve_params.rbi +38 -0
  116. data/rbi/vitable_connect/models/webhook_event_retrieve_response.rbi +34 -0
  117. data/rbi/vitable_connect/models.rbi +62 -0
  118. data/rbi/vitable_connect/request_options.rbi +61 -0
  119. data/rbi/vitable_connect/resources/auth.rbi +36 -0
  120. data/rbi/vitable_connect/resources/benefit_eligibility_policies.rbi +27 -0
  121. data/rbi/vitable_connect/resources/employees.rbi +49 -0
  122. data/rbi/vitable_connect/resources/employers.rbi +147 -0
  123. data/rbi/vitable_connect/resources/enrollments.rbi +27 -0
  124. data/rbi/vitable_connect/resources/webhook_events.rbi +84 -0
  125. data/rbi/vitable_connect/version.rbi +5 -0
  126. data/sig/vitable_connect/client.rbs +42 -0
  127. data/sig/vitable_connect/errors.rbs +117 -0
  128. data/sig/vitable_connect/file_part.rbs +21 -0
  129. data/sig/vitable_connect/internal/page_number_page.rbs +28 -0
  130. data/sig/vitable_connect/internal/transport/base_client.rbs +133 -0
  131. data/sig/vitable_connect/internal/transport/pooled_net_requester.rbs +48 -0
  132. data/sig/vitable_connect/internal/type/array_of.rbs +48 -0
  133. data/sig/vitable_connect/internal/type/base_model.rbs +104 -0
  134. data/sig/vitable_connect/internal/type/base_page.rbs +24 -0
  135. data/sig/vitable_connect/internal/type/boolean.rbs +26 -0
  136. data/sig/vitable_connect/internal/type/converter.rbs +79 -0
  137. data/sig/vitable_connect/internal/type/enum.rbs +32 -0
  138. data/sig/vitable_connect/internal/type/file_input.rbs +25 -0
  139. data/sig/vitable_connect/internal/type/hash_of.rbs +48 -0
  140. data/sig/vitable_connect/internal/type/request_parameters.rbs +20 -0
  141. data/sig/vitable_connect/internal/type/union.rbs +52 -0
  142. data/sig/vitable_connect/internal/type/unknown.rbs +26 -0
  143. data/sig/vitable_connect/internal/util.rbs +195 -0
  144. data/sig/vitable_connect/internal.rbs +10 -0
  145. data/sig/vitable_connect/models/auth_issue_access_token_params.rbs +56 -0
  146. data/sig/vitable_connect/models/auth_issue_access_token_response.rbs +50 -0
  147. data/sig/vitable_connect/models/benefit_eligibility_policy.rbs +50 -0
  148. data/sig/vitable_connect/models/benefit_eligibility_policy_response.rbs +14 -0
  149. data/sig/vitable_connect/models/benefit_eligibility_policy_retrieve_params.rbs +23 -0
  150. data/sig/vitable_connect/models/employee.rbs +169 -0
  151. data/sig/vitable_connect/models/employee_class.rbs +24 -0
  152. data/sig/vitable_connect/models/employee_list_enrollments_params.rbs +36 -0
  153. data/sig/vitable_connect/models/employee_retrieve_params.rbs +24 -0
  154. data/sig/vitable_connect/models/employee_retrieve_response.rbs +13 -0
  155. data/sig/vitable_connect/models/employer.rbs +117 -0
  156. data/sig/vitable_connect/models/employer_create_benefit_eligibility_policy_params.rbs +32 -0
  157. data/sig/vitable_connect/models/employer_create_params.rbs +93 -0
  158. data/sig/vitable_connect/models/employer_list_employees_params.rbs +36 -0
  159. data/sig/vitable_connect/models/employer_list_params.rbs +32 -0
  160. data/sig/vitable_connect/models/employer_response.rbs +13 -0
  161. data/sig/vitable_connect/models/employer_retrieve_params.rbs +24 -0
  162. data/sig/vitable_connect/models/employer_submit_census_sync_params.rbs +274 -0
  163. data/sig/vitable_connect/models/employer_submit_census_sync_response.rbs +30 -0
  164. data/sig/vitable_connect/models/enrollment.rbs +164 -0
  165. data/sig/vitable_connect/models/enrollment_retrieve_params.rbs +24 -0
  166. data/sig/vitable_connect/models/enrollment_retrieve_response.rbs +13 -0
  167. data/sig/vitable_connect/models/enrollment_status.rbs +16 -0
  168. data/sig/vitable_connect/models/pagination.rbs +30 -0
  169. data/sig/vitable_connect/models/type.rbs +14 -0
  170. data/sig/vitable_connect/models/webhook_event.rbs +45 -0
  171. data/sig/vitable_connect/models/webhook_event_list_deliveries_params.rbs +23 -0
  172. data/sig/vitable_connect/models/webhook_event_list_deliveries_response.rbs +77 -0
  173. data/sig/vitable_connect/models/webhook_event_list_params.rbs +126 -0
  174. data/sig/vitable_connect/models/webhook_event_retrieve_params.rbs +23 -0
  175. data/sig/vitable_connect/models/webhook_event_retrieve_response.rbs +14 -0
  176. data/sig/vitable_connect/models.rbs +51 -0
  177. data/sig/vitable_connect/request_options.rbs +36 -0
  178. data/sig/vitable_connect/resources/auth.rbs +13 -0
  179. data/sig/vitable_connect/resources/benefit_eligibility_policies.rbs +12 -0
  180. data/sig/vitable_connect/resources/employees.rbs +19 -0
  181. data/sig/vitable_connect/resources/employers.rbs +49 -0
  182. data/sig/vitable_connect/resources/enrollments.rbs +12 -0
  183. data/sig/vitable_connect/resources/webhook_events.rbs +28 -0
  184. data/sig/vitable_connect/version.rbs +3 -0
  185. metadata +256 -0
@@ -0,0 +1,374 @@
1
+ # frozen_string_literal: true
2
+
3
+ module VitableConnect
4
+ module Models
5
+ # @see VitableConnect::Resources::Employers#submit_census_sync
6
+ class EmployerSubmitCensusSyncParams < 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 employees
17
+ #
18
+ # @return [Array<VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee>]
19
+ required :employees,
20
+ -> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::EmployerSubmitCensusSyncParams::Employee] }
21
+
22
+ # @!method initialize(employer_id:, employees:, request_options: {})
23
+ # @param employer_id [String] Unique employer identifier (empr\_\*)
24
+ #
25
+ # @param employees [Array<VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee>]
26
+ #
27
+ # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
28
+
29
+ class Employee < VitableConnect::Internal::Type::BaseModel
30
+ # @!attribute date_of_birth
31
+ #
32
+ # @return [Date]
33
+ required :date_of_birth, Date
34
+
35
+ # @!attribute email
36
+ #
37
+ # @return [String]
38
+ required :email, String
39
+
40
+ # @!attribute first_name
41
+ #
42
+ # @return [String]
43
+ required :first_name, String
44
+
45
+ # @!attribute last_name
46
+ #
47
+ # @return [String]
48
+ required :last_name, String
49
+
50
+ # @!attribute phone
51
+ #
52
+ # @return [String]
53
+ required :phone, String
54
+
55
+ # @!attribute address
56
+ #
57
+ # @return [VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address, nil]
58
+ optional :address,
59
+ -> {
60
+ VitableConnect::EmployerSubmitCensusSyncParams::Employee::Address
61
+ },
62
+ nil?: true
63
+
64
+ # @!attribute compensation_type
65
+ # - `Salary` - Salary
66
+ # - `Hourly` - Hourly
67
+ #
68
+ # @return [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::CompensationType, nil]
69
+ optional :compensation_type,
70
+ enum: -> { VitableConnect::EmployerSubmitCensusSyncParams::Employee::CompensationType },
71
+ nil?: true
72
+
73
+ # @!attribute employee_class
74
+ # - `Full Time` - Full Time
75
+ # - `Part Time` - Part Time
76
+ # - `Temporary` - Temporary
77
+ # - `Intern` - Intern
78
+ # - `Seasonal` - Seasonal
79
+ # - `Individual Contractor` - Individual Contractor
80
+ #
81
+ # @return [Symbol, VitableConnect::Models::EmployeeClass, nil]
82
+ optional :employee_class, enum: -> { VitableConnect::EmployeeClass }, nil?: true
83
+
84
+ # @!attribute reference_id
85
+ #
86
+ # @return [String, nil]
87
+ optional :reference_id, String, nil?: true
88
+
89
+ # @!attribute start_date
90
+ #
91
+ # @return [Date, nil]
92
+ optional :start_date, Date, nil?: true
93
+
94
+ # @!method initialize(date_of_birth:, email:, first_name:, last_name:, phone:, address: nil, compensation_type: nil, employee_class: nil, reference_id: nil, start_date: nil)
95
+ # Some parameter documentations has been truncated, see
96
+ # {VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee} for more
97
+ # details.
98
+ #
99
+ # @param date_of_birth [Date]
100
+ #
101
+ # @param email [String]
102
+ #
103
+ # @param first_name [String]
104
+ #
105
+ # @param last_name [String]
106
+ #
107
+ # @param phone [String]
108
+ #
109
+ # @param address [VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address, nil]
110
+ #
111
+ # @param compensation_type [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::CompensationType, nil] - `Salary` - Salary
112
+ #
113
+ # @param employee_class [Symbol, VitableConnect::Models::EmployeeClass, nil] - `Full Time` - Full Time
114
+ #
115
+ # @param reference_id [String, nil]
116
+ #
117
+ # @param start_date [Date, nil]
118
+
119
+ # @see VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee#address
120
+ class Address < VitableConnect::Internal::Type::BaseModel
121
+ # @!attribute address_line_1
122
+ #
123
+ # @return [String]
124
+ required :address_line_1, String
125
+
126
+ # @!attribute city
127
+ #
128
+ # @return [String]
129
+ required :city, String
130
+
131
+ # @!attribute state
132
+ # - `AL` - AL
133
+ # - `AK` - AK
134
+ # - `AZ` - AZ
135
+ # - `AR` - AR
136
+ # - `CA` - CA
137
+ # - `CO` - CO
138
+ # - `CT` - CT
139
+ # - `DC` - DC
140
+ # - `DE` - DE
141
+ # - `FL` - FL
142
+ # - `GA` - GA
143
+ # - `HI` - HI
144
+ # - `ID` - ID
145
+ # - `IL` - IL
146
+ # - `IN` - IN
147
+ # - `IA` - IA
148
+ # - `KS` - KS
149
+ # - `KY` - KY
150
+ # - `LA` - LA
151
+ # - `ME` - ME
152
+ # - `MD` - MD
153
+ # - `MA` - MA
154
+ # - `MI` - MI
155
+ # - `MN` - MN
156
+ # - `MS` - MS
157
+ # - `MO` - MO
158
+ # - `MT` - MT
159
+ # - `NE` - NE
160
+ # - `NV` - NV
161
+ # - `NH` - NH
162
+ # - `NJ` - NJ
163
+ # - `NM` - NM
164
+ # - `NY` - NY
165
+ # - `NC` - NC
166
+ # - `ND` - ND
167
+ # - `OH` - OH
168
+ # - `OK` - OK
169
+ # - `OR` - OR
170
+ # - `PA` - PA
171
+ # - `RI` - RI
172
+ # - `SC` - SC
173
+ # - `SD` - SD
174
+ # - `TN` - TN
175
+ # - `TX` - TX
176
+ # - `UT` - UT
177
+ # - `VT` - VT
178
+ # - `VA` - VA
179
+ # - `WA` - WA
180
+ # - `WI` - WI
181
+ # - `WV` - WV
182
+ # - `WY` - WY
183
+ # - `PR` - PR
184
+ # - `GU` - GU
185
+ # - `AS` - AS
186
+ # - `VI` - VI
187
+ # - `MP` - MP
188
+ # - `MH` - MH
189
+ # - `PW` - PW
190
+ # - `FM` - FM
191
+ # - `AE` - AE
192
+ # - `AA` - AA
193
+ # - `AP` - AP
194
+ #
195
+ # @return [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address::State]
196
+ required :state, enum: -> { VitableConnect::EmployerSubmitCensusSyncParams::Employee::Address::State }
197
+
198
+ # @!attribute zipcode
199
+ #
200
+ # @return [String]
201
+ required :zipcode, String
202
+
203
+ # @!attribute address_line_2
204
+ #
205
+ # @return [String, nil]
206
+ optional :address_line_2, String, nil?: true
207
+
208
+ # @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
209
+ # Some parameter documentations has been truncated, see
210
+ # {VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address} for
211
+ # more details.
212
+ #
213
+ # @param address_line_1 [String]
214
+ #
215
+ # @param city [String]
216
+ #
217
+ # @param state [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address::State] - `AL` - AL
218
+ #
219
+ # @param zipcode [String]
220
+ #
221
+ # @param address_line_2 [String, nil]
222
+
223
+ # - `AL` - AL
224
+ # - `AK` - AK
225
+ # - `AZ` - AZ
226
+ # - `AR` - AR
227
+ # - `CA` - CA
228
+ # - `CO` - CO
229
+ # - `CT` - CT
230
+ # - `DC` - DC
231
+ # - `DE` - DE
232
+ # - `FL` - FL
233
+ # - `GA` - GA
234
+ # - `HI` - HI
235
+ # - `ID` - ID
236
+ # - `IL` - IL
237
+ # - `IN` - IN
238
+ # - `IA` - IA
239
+ # - `KS` - KS
240
+ # - `KY` - KY
241
+ # - `LA` - LA
242
+ # - `ME` - ME
243
+ # - `MD` - MD
244
+ # - `MA` - MA
245
+ # - `MI` - MI
246
+ # - `MN` - MN
247
+ # - `MS` - MS
248
+ # - `MO` - MO
249
+ # - `MT` - MT
250
+ # - `NE` - NE
251
+ # - `NV` - NV
252
+ # - `NH` - NH
253
+ # - `NJ` - NJ
254
+ # - `NM` - NM
255
+ # - `NY` - NY
256
+ # - `NC` - NC
257
+ # - `ND` - ND
258
+ # - `OH` - OH
259
+ # - `OK` - OK
260
+ # - `OR` - OR
261
+ # - `PA` - PA
262
+ # - `RI` - RI
263
+ # - `SC` - SC
264
+ # - `SD` - SD
265
+ # - `TN` - TN
266
+ # - `TX` - TX
267
+ # - `UT` - UT
268
+ # - `VT` - VT
269
+ # - `VA` - VA
270
+ # - `WA` - WA
271
+ # - `WI` - WI
272
+ # - `WV` - WV
273
+ # - `WY` - WY
274
+ # - `PR` - PR
275
+ # - `GU` - GU
276
+ # - `AS` - AS
277
+ # - `VI` - VI
278
+ # - `MP` - MP
279
+ # - `MH` - MH
280
+ # - `PW` - PW
281
+ # - `FM` - FM
282
+ # - `AE` - AE
283
+ # - `AA` - AA
284
+ # - `AP` - AP
285
+ #
286
+ # @see VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address#state
287
+ module State
288
+ extend VitableConnect::Internal::Type::Enum
289
+
290
+ AL = :AL
291
+ AK = :AK
292
+ AZ = :AZ
293
+ AR = :AR
294
+ CA = :CA
295
+ CO = :CO
296
+ CT = :CT
297
+ DC = :DC
298
+ DE = :DE
299
+ FL = :FL
300
+ GA = :GA
301
+ HI = :HI
302
+ ID = :ID
303
+ IL = :IL
304
+ IN = :IN
305
+ IA = :IA
306
+ KS = :KS
307
+ KY = :KY
308
+ LA = :LA
309
+ ME = :ME
310
+ MD = :MD
311
+ MA = :MA
312
+ MI = :MI
313
+ MN = :MN
314
+ MS = :MS
315
+ MO = :MO
316
+ MT = :MT
317
+ NE = :NE
318
+ NV = :NV
319
+ NH = :NH
320
+ NJ = :NJ
321
+ NM = :NM
322
+ NY = :NY
323
+ NC = :NC
324
+ ND = :ND
325
+ OH = :OH
326
+ OK = :OK
327
+ OR = :OR
328
+ PA = :PA
329
+ RI = :RI
330
+ SC = :SC
331
+ SD = :SD
332
+ TN = :TN
333
+ TX = :TX
334
+ UT = :UT
335
+ VT = :VT
336
+ VA = :VA
337
+ WA = :WA
338
+ WI = :WI
339
+ WV = :WV
340
+ WY = :WY
341
+ PR = :PR
342
+ GU = :GU
343
+ AS = :AS
344
+ VI = :VI
345
+ MP = :MP
346
+ MH = :MH
347
+ PW = :PW
348
+ FM = :FM
349
+ AE = :AE
350
+ AA = :AA
351
+ AP = :AP
352
+
353
+ # @!method self.values
354
+ # @return [Array<Symbol>]
355
+ end
356
+ end
357
+
358
+ # - `Salary` - Salary
359
+ # - `Hourly` - Hourly
360
+ #
361
+ # @see VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee#compensation_type
362
+ module CompensationType
363
+ extend VitableConnect::Internal::Type::Enum
364
+
365
+ SALARY = :Salary
366
+ HOURLY = :Hourly
367
+
368
+ # @!method self.values
369
+ # @return [Array<Symbol>]
370
+ end
371
+ end
372
+ end
373
+ end
374
+ end
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module VitableConnect
4
+ module Models
5
+ # @see VitableConnect::Resources::Employers#submit_census_sync
6
+ class EmployerSubmitCensusSyncResponse < VitableConnect::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [VitableConnect::Models::EmployerSubmitCensusSyncResponse::Data]
10
+ required :data, -> { VitableConnect::Models::EmployerSubmitCensusSyncResponse::Data }
11
+
12
+ # @!method initialize(data:)
13
+ # Response containing a single census sync detail resource.
14
+ #
15
+ # @param data [VitableConnect::Models::EmployerSubmitCensusSyncResponse::Data]
16
+
17
+ # @see VitableConnect::Models::EmployerSubmitCensusSyncResponse#data
18
+ class Data < VitableConnect::Internal::Type::BaseModel
19
+ # @!attribute accepted_at
20
+ #
21
+ # @return [Time]
22
+ required :accepted_at, Time
23
+
24
+ # @!attribute employer_id
25
+ #
26
+ # @return [String]
27
+ required :employer_id, String
28
+
29
+ # @!method initialize(accepted_at:, employer_id:)
30
+ # @param accepted_at [Time]
31
+ # @param employer_id [String]
32
+ end
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,234 @@
1
+ # frozen_string_literal: true
2
+
3
+ module VitableConnect
4
+ module Models
5
+ class Enrollment < VitableConnect::Internal::Type::BaseModel
6
+ # @!attribute id
7
+ # Unique enrollment identifier (enrl\_\*)
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute answered_at
13
+ # When the employee enrolled or waived
14
+ #
15
+ # @return [Time, nil]
16
+ required :answered_at, Time, nil?: true
17
+
18
+ # @!attribute benefit
19
+ # Nested benefit product summary
20
+ #
21
+ # @return [VitableConnect::Models::Enrollment::Benefit]
22
+ required :benefit, -> { VitableConnect::Enrollment::Benefit }
23
+
24
+ # @!attribute coverage_end
25
+ # Coverage period end date
26
+ #
27
+ # @return [Date, nil]
28
+ required :coverage_end, Date, nil?: true
29
+
30
+ # @!attribute coverage_start
31
+ # Coverage period start date
32
+ #
33
+ # @return [Date]
34
+ required :coverage_start, Date
35
+
36
+ # @!attribute created_at
37
+ # When the enrollment was created
38
+ #
39
+ # @return [Time]
40
+ required :created_at, Time
41
+
42
+ # @!attribute employee_deduction_in_cents
43
+ # Employee monthly payroll deduction in cents
44
+ #
45
+ # @return [Integer, nil]
46
+ required :employee_deduction_in_cents, Integer, nil?: true
47
+
48
+ # @!attribute employee_id
49
+ # Employee ID (empl\_\*)
50
+ #
51
+ # @return [String]
52
+ required :employee_id, String
53
+
54
+ # @!attribute employer_contribution_in_cents
55
+ # Employer monthly contribution in cents
56
+ #
57
+ # @return [Integer, nil]
58
+ required :employer_contribution_in_cents, Integer, nil?: true
59
+
60
+ # @!attribute employer_id
61
+ # Employer ID (empr\_\*)
62
+ #
63
+ # @return [String]
64
+ required :employer_id, String
65
+
66
+ # @!attribute status
67
+ # - `pending` - Pending
68
+ # - `enrolled` - Enrolled
69
+ # - `waived` - Waived
70
+ # - `inactive` - Inactive
71
+ #
72
+ # @return [Symbol, VitableConnect::Models::EnrollmentStatus]
73
+ required :status, enum: -> { VitableConnect::EnrollmentStatus }
74
+
75
+ # @!attribute terminated_at
76
+ # When coverage was terminated
77
+ #
78
+ # @return [Time, nil]
79
+ required :terminated_at, Time, nil?: true
80
+
81
+ # @!attribute updated_at
82
+ # When the enrollment was last updated
83
+ #
84
+ # @return [Time]
85
+ required :updated_at, Time
86
+
87
+ # @!method initialize(id:, answered_at:, benefit:, coverage_end:, coverage_start:, created_at:, employee_deduction_in_cents:, employee_id:, employer_contribution_in_cents:, employer_id:, status:, terminated_at:, updated_at:)
88
+ # Some parameter documentations has been truncated, see
89
+ # {VitableConnect::Models::Enrollment} for more details.
90
+ #
91
+ # @param id [String] Unique enrollment identifier (enrl\_\*)
92
+ #
93
+ # @param answered_at [Time, nil] When the employee enrolled or waived
94
+ #
95
+ # @param benefit [VitableConnect::Models::Enrollment::Benefit] Nested benefit product summary
96
+ #
97
+ # @param coverage_end [Date, nil] Coverage period end date
98
+ #
99
+ # @param coverage_start [Date] Coverage period start date
100
+ #
101
+ # @param created_at [Time] When the enrollment was created
102
+ #
103
+ # @param employee_deduction_in_cents [Integer, nil] Employee monthly payroll deduction in cents
104
+ #
105
+ # @param employee_id [String] Employee ID (empl\_\*)
106
+ #
107
+ # @param employer_contribution_in_cents [Integer, nil] Employer monthly contribution in cents
108
+ #
109
+ # @param employer_id [String] Employer ID (empr\_\*)
110
+ #
111
+ # @param status [Symbol, VitableConnect::Models::EnrollmentStatus] - `pending` - Pending
112
+ #
113
+ # @param terminated_at [Time, nil] When coverage was terminated
114
+ #
115
+ # @param updated_at [Time] When the enrollment was last updated
116
+
117
+ # @see VitableConnect::Models::Enrollment#benefit
118
+ class Benefit < VitableConnect::Internal::Type::BaseModel
119
+ # @!attribute id
120
+ # Benefit product ID (bprd\_\*)
121
+ #
122
+ # @return [String]
123
+ required :id, String
124
+
125
+ # @!attribute category
126
+ # - `Medical` - Medical
127
+ # - `Dental` - Dental
128
+ # - `Vision` - Vision
129
+ # - `Hospital` - Hospital
130
+ #
131
+ # @return [Symbol, VitableConnect::Models::Enrollment::Benefit::Category]
132
+ required :category, enum: -> { VitableConnect::Enrollment::Benefit::Category }
133
+
134
+ # @!attribute name
135
+ # Display name of the benefit product
136
+ #
137
+ # @return [String]
138
+ required :name, String
139
+
140
+ # @!attribute product_code
141
+ # - `EBA` - Eba Mec
142
+ # - `VPC` - Vpc Enhanced
143
+ # - `VPC_CORE` - Vpc Core
144
+ # - `MEC` - Vpc Mec
145
+ # - `MEC2` - Mec2
146
+ # - `MEC_PLUS` - Mec Plus
147
+ # - `MVP` - Mvp
148
+ # - `MVP2` - Mvp2
149
+ # - `MVPSL` - Mvpsl
150
+ # - `MVPSL2` - Mvpsl2
151
+ # - `VD` - Dental
152
+ # - `VV` - Vision
153
+ # - `ICHRA` - Ichra
154
+ # - `ICHRA_PREMIUM_PLUS` - Ichra Premium Plus
155
+ # - `ICHRA_REIMBURSEMENT_ONLY` - Ichra Reimbursement Only
156
+ #
157
+ # @return [Symbol, VitableConnect::Models::Enrollment::Benefit::ProductCode]
158
+ required :product_code, enum: -> { VitableConnect::Enrollment::Benefit::ProductCode }
159
+
160
+ # @!method initialize(id:, category:, name:, product_code:)
161
+ # Some parameter documentations has been truncated, see
162
+ # {VitableConnect::Models::Enrollment::Benefit} for more details.
163
+ #
164
+ # Nested benefit product summary
165
+ #
166
+ # @param id [String] Benefit product ID (bprd\_\*)
167
+ #
168
+ # @param category [Symbol, VitableConnect::Models::Enrollment::Benefit::Category] - `Medical` - Medical
169
+ #
170
+ # @param name [String] Display name of the benefit product
171
+ #
172
+ # @param product_code [Symbol, VitableConnect::Models::Enrollment::Benefit::ProductCode] - `EBA` - Eba Mec
173
+
174
+ # - `Medical` - Medical
175
+ # - `Dental` - Dental
176
+ # - `Vision` - Vision
177
+ # - `Hospital` - Hospital
178
+ #
179
+ # @see VitableConnect::Models::Enrollment::Benefit#category
180
+ module Category
181
+ extend VitableConnect::Internal::Type::Enum
182
+
183
+ MEDICAL = :Medical
184
+ DENTAL = :Dental
185
+ VISION = :Vision
186
+ HOSPITAL = :Hospital
187
+
188
+ # @!method self.values
189
+ # @return [Array<Symbol>]
190
+ end
191
+
192
+ # - `EBA` - Eba Mec
193
+ # - `VPC` - Vpc Enhanced
194
+ # - `VPC_CORE` - Vpc Core
195
+ # - `MEC` - Vpc Mec
196
+ # - `MEC2` - Mec2
197
+ # - `MEC_PLUS` - Mec Plus
198
+ # - `MVP` - Mvp
199
+ # - `MVP2` - Mvp2
200
+ # - `MVPSL` - Mvpsl
201
+ # - `MVPSL2` - Mvpsl2
202
+ # - `VD` - Dental
203
+ # - `VV` - Vision
204
+ # - `ICHRA` - Ichra
205
+ # - `ICHRA_PREMIUM_PLUS` - Ichra Premium Plus
206
+ # - `ICHRA_REIMBURSEMENT_ONLY` - Ichra Reimbursement Only
207
+ #
208
+ # @see VitableConnect::Models::Enrollment::Benefit#product_code
209
+ module ProductCode
210
+ extend VitableConnect::Internal::Type::Enum
211
+
212
+ EBA = :EBA
213
+ VPC = :VPC
214
+ VPC_CORE = :VPC_CORE
215
+ MEC = :MEC
216
+ MEC2 = :MEC2
217
+ MEC_PLUS = :MEC_PLUS
218
+ MVP = :MVP
219
+ MVP2 = :MVP2
220
+ MVPSL = :MVPSL
221
+ MVPSL2 = :MVPSL2
222
+ VD = :VD
223
+ VV = :VV
224
+ ICHRA = :ICHRA
225
+ ICHRA_PREMIUM_PLUS = :ICHRA_PREMIUM_PLUS
226
+ ICHRA_REIMBURSEMENT_ONLY = :ICHRA_REIMBURSEMENT_ONLY
227
+
228
+ # @!method self.values
229
+ # @return [Array<Symbol>]
230
+ end
231
+ end
232
+ end
233
+ end
234
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module VitableConnect
4
+ module Models
5
+ # @see VitableConnect::Resources::Enrollments#retrieve
6
+ class EnrollmentRetrieveParams < VitableConnect::Internal::Type::BaseModel
7
+ extend VitableConnect::Internal::Type::RequestParameters::Converter
8
+ include VitableConnect::Internal::Type::RequestParameters
9
+
10
+ # @!attribute enrollment_id
11
+ # Unique enrollment identifier (enrl\_\*)
12
+ #
13
+ # @return [String]
14
+ required :enrollment_id, String
15
+
16
+ # @!method initialize(enrollment_id:, request_options: {})
17
+ # @param enrollment_id [String] Unique enrollment identifier (enrl\_\*)
18
+ #
19
+ # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module VitableConnect
4
+ module Models
5
+ # @see VitableConnect::Resources::Enrollments#retrieve
6
+ class EnrollmentRetrieveResponse < VitableConnect::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [VitableConnect::Models::Enrollment]
10
+ required :data, -> { VitableConnect::Enrollment }
11
+
12
+ # @!method initialize(data:)
13
+ # Response containing a single enrollment resource.
14
+ #
15
+ # @param data [VitableConnect::Models::Enrollment]
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ module VitableConnect
4
+ module Models
5
+ # - `pending` - Pending
6
+ # - `enrolled` - Enrolled
7
+ # - `waived` - Waived
8
+ # - `inactive` - Inactive
9
+ module EnrollmentStatus
10
+ extend VitableConnect::Internal::Type::Enum
11
+
12
+ PENDING = :pending
13
+ ENROLLED = :enrolled
14
+ WAIVED = :waived
15
+ INACTIVE = :inactive
16
+
17
+ # @!method self.values
18
+ # @return [Array<Symbol>]
19
+ end
20
+ end
21
+ end