Class: VitableConnect::Models::MemberListIDCardsResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/vitable_connect/models/member_list_id_cards_response.rb,
sig/vitable_connect/models/member_list_id_cards_response.rbs

Defined Under Namespace

Modules: BenefitCode, CardType Classes: Network

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(card_type:, group_id:, group_member_id:, member_name:, nsa_table:, benefit_code: nil, carrier_phone: nil, carrier_website: nil, claims_payer_display_name: nil, employer_name: nil, general_disclaimer: nil, network: nil, plan_disclaimer: nil, plan_name: nil) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::MemberListIDCardsResponse::Data for more details.

Wire serializer for :class:DigitalBenefitCardDTO (one benefit ID card).

Parameters:

  • card_type (Symbol, VitableConnect::Models::MemberListIDCardsResponse::Data::CardType) —
    • medical - medical
  • group_id (String) —

    Group number printed on the card (the rx group id for an rx card)

  • group_member_id (String) —

    Member id printed on the card (the Ventegra cardholder id for an rx card)

  • member_name (String) —

    Name of the member the card is issued to

  • nsa_table (Array<Array<String>>) —

    No Surprises Act cost-sharing table rendered on the card; empty for an rx card

  • benefit_code (Symbol, VitableConnect::Models::MemberListIDCardsResponse::Data::BenefitCode, nil) (defaults to: nil) —
    • EBA - Eba Mec
  • carrier_phone (String, nil) (defaults to: nil) —

    Carrier phone number on the card; null for an rx card

  • carrier_website (String, nil) (defaults to: nil) —

    Carrier website on the card; null for an rx card

  • claims_payer_display_name (String, nil) (defaults to: nil) —

    Claims payer shown on the card

  • employer_name (String, nil) (defaults to: nil) —

    Employer the card's coverage is through; null for an rx card without group info

  • general_disclaimer (String, nil) (defaults to: nil) —

    General disclaimer text; null for an rx card

  • network (VitableConnect::Models::MemberListIDCardsResponse::Data::Network, nil) (defaults to: nil) —

    Provider network shown on the card; null for an rx card

  • plan_disclaimer (String, nil) (defaults to: nil) —

    Plan-specific disclaimer text; null for an rx card

  • plan_name (String, nil) (defaults to: nil) —

    Benefit plan name on the card; null for a consumer-membership rx card



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 18

class Data < VitableConnect::Internal::Type::BaseModel
  # @!attribute card_type
  #   - `medical` - medical
  #   - `dental` - dental
  #   - `vision` - vision
  #   - `rx` - rx
  #
  #   @return [Symbol, VitableConnect::Models::MemberListIDCardsResponse::Data::CardType]
  required :card_type, enum: -> { VitableConnect::Models::MemberListIDCardsResponse::Data::CardType }

  # @!attribute group_id
  #   Group number printed on the card (the rx group id for an rx card)
  #
  #   @return [String]
  required :group_id, String

  # @!attribute group_member_id
  #   Member id printed on the card (the Ventegra cardholder id for an rx card)
  #
  #   @return [String]
  required :group_member_id, String

  # @!attribute member_name
  #   Name of the member the card is issued to
  #
  #   @return [String]
  required :member_name, String

  # @!attribute nsa_table
  #   No Surprises Act cost-sharing table rendered on the card; empty for an rx card
  #
  #   @return [Array<Array<String>>]
  required :nsa_table,
           VitableConnect::Internal::Type::ArrayOf[VitableConnect::Internal::Type::ArrayOf[String]]

  # @!attribute benefit_code
  #   - `EBA` - Eba Mec
  #   - `VPC` - Vpc Enhanced
  #   - `VPC_CORE` - Vpc Core
  #   - `MEC` - Vpc Mec
  #   - `MEC2` - Mec2
  #   - `MEC_PLUS` - Mec Plus
  #   - `MVP` - Mvp
  #   - `MVP2` - Mvp2
  #   - `MVPSL` - Mvpsl
  #   - `MVPSL2` - Mvpsl2
  #   - `VD` - Dental
  #   - `VV` - Vision
  #   - `ICHRA` - Ichra
  #   - `ICHRA_PREMIUM_PLUS` - Ichra Premium Plus
  #   - `ICHRA_REIMBURSEMENT_ONLY` - Ichra Reimbursement Only
  #
  #   @return [Symbol, VitableConnect::Models::MemberListIDCardsResponse::Data::BenefitCode, nil]
  optional :benefit_code,
           enum: -> { VitableConnect::Models::MemberListIDCardsResponse::Data::BenefitCode },
           nil?: true

  # @!attribute carrier_phone
  #   Carrier phone number on the card; null for an rx card
  #
  #   @return [String, nil]
  optional :carrier_phone, String, nil?: true

  # @!attribute carrier_website
  #   Carrier website on the card; null for an rx card
  #
  #   @return [String, nil]
  optional :carrier_website, String, nil?: true

  # @!attribute claims_payer_display_name
  #   Claims payer shown on the card
  #
  #   @return [String, nil]
  optional :claims_payer_display_name, String, nil?: true

  # @!attribute employer_name
  #   Employer the card's coverage is through; null for an rx card without group info
  #
  #   @return [String, nil]
  optional :employer_name, String, nil?: true

  # @!attribute general_disclaimer
  #   General disclaimer text; null for an rx card
  #
  #   @return [String, nil]
  optional :general_disclaimer, String, nil?: true

  # @!attribute network
  #   Provider network shown on the card; null for an rx card
  #
  #   @return [VitableConnect::Models::MemberListIDCardsResponse::Data::Network, nil]
  optional :network, -> { VitableConnect::Models::MemberListIDCardsResponse::Data::Network }, nil?: true

  # @!attribute plan_disclaimer
  #   Plan-specific disclaimer text; null for an rx card
  #
  #   @return [String, nil]
  optional :plan_disclaimer, String, nil?: true

  # @!attribute plan_name
  #   Benefit plan name on the card; null for a consumer-membership rx card
  #
  #   @return [String, nil]
  optional :plan_name, String, nil?: true

  # @!method initialize(card_type:, group_id:, group_member_id:, member_name:, nsa_table:, benefit_code: nil, carrier_phone: nil, carrier_website: nil, claims_payer_display_name: nil, employer_name: nil, general_disclaimer: nil, network: nil, plan_disclaimer: nil, plan_name: nil)
  #   Some parameter documentations has been truncated, see
  #   {VitableConnect::Models::MemberListIDCardsResponse::Data} for more details.
  #
  #   Wire serializer for :class:`DigitalBenefitCardDTO` (one benefit ID card).
  #
  #   @param card_type [Symbol, VitableConnect::Models::MemberListIDCardsResponse::Data::CardType] - `medical` - medical
  #
  #   @param group_id [String] Group number printed on the card (the rx group id for an rx card)
  #
  #   @param group_member_id [String] Member id printed on the card (the Ventegra cardholder id for an rx card)
  #
  #   @param member_name [String] Name of the member the card is issued to
  #
  #   @param nsa_table [Array<Array<String>>] No Surprises Act cost-sharing table rendered on the card; empty for an rx card
  #
  #   @param benefit_code [Symbol, VitableConnect::Models::MemberListIDCardsResponse::Data::BenefitCode, nil] - `EBA` - Eba Mec
  #
  #   @param carrier_phone [String, nil] Carrier phone number on the card; null for an rx card
  #
  #   @param carrier_website [String, nil] Carrier website on the card; null for an rx card
  #
  #   @param claims_payer_display_name [String, nil] Claims payer shown on the card
  #
  #   @param employer_name [String, nil] Employer the card's coverage is through; null for an rx card without group info
  #
  #   @param general_disclaimer [String, nil] General disclaimer text; null for an rx card
  #
  #   @param network [VitableConnect::Models::MemberListIDCardsResponse::Data::Network, nil] Provider network shown on the card; null for an rx card
  #
  #   @param plan_disclaimer [String, nil] Plan-specific disclaimer text; null for an rx card
  #
  #   @param plan_name [String, nil] Benefit plan name on the card; null for a consumer-membership rx card

  # - `medical` - medical
  # - `dental` - dental
  # - `vision` - vision
  # - `rx` - rx
  #
  # @see VitableConnect::Models::MemberListIDCardsResponse::Data#card_type
  module CardType
    extend VitableConnect::Internal::Type::Enum

    MEDICAL = :medical
    DENTAL = :dental
    VISION = :vision
    RX = :rx

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # - `EBA` - Eba Mec
  # - `VPC` - Vpc Enhanced
  # - `VPC_CORE` - Vpc Core
  # - `MEC` - Vpc Mec
  # - `MEC2` - Mec2
  # - `MEC_PLUS` - Mec Plus
  # - `MVP` - Mvp
  # - `MVP2` - Mvp2
  # - `MVPSL` - Mvpsl
  # - `MVPSL2` - Mvpsl2
  # - `VD` - Dental
  # - `VV` - Vision
  # - `ICHRA` - Ichra
  # - `ICHRA_PREMIUM_PLUS` - Ichra Premium Plus
  # - `ICHRA_REIMBURSEMENT_ONLY` - Ichra Reimbursement Only
  #
  # @see VitableConnect::Models::MemberListIDCardsResponse::Data#benefit_code
  module BenefitCode
    extend VitableConnect::Internal::Type::Enum

    EBA = :EBA
    VPC = :VPC
    VPC_CORE = :VPC_CORE
    MEC = :MEC
    MEC2 = :MEC2
    MEC_PLUS = :MEC_PLUS
    MVP = :MVP
    MVP2 = :MVP2
    MVPSL = :MVPSL
    MVPSL2 = :MVPSL2
    VD = :VD
    VV = :VV
    ICHRA = :ICHRA
    ICHRA_PREMIUM_PLUS = :ICHRA_PREMIUM_PLUS
    ICHRA_REIMBURSEMENT_ONLY = :ICHRA_REIMBURSEMENT_ONLY

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see VitableConnect::Models::MemberListIDCardsResponse::Data#network
  class Network < VitableConnect::Internal::Type::BaseModel
    # @!attribute address
    #   Shared read serializer for a postal address on public API responses.
    #
    #   One definition for the address block every public resource emits (employer,
    #   employee, …), so the 5-field shape isn't hand-rolled per endpoint. Read-only: it
    #   renders an already-built address value object (e.g. `AddressDVO`) whose
    #   attributes map 1:1 to these fields.
    #
    #   @return [VitableConnect::Models::MemberListIDCardsResponse::Data::Network::Address]
    required :address, -> { VitableConnect::Models::MemberListIDCardsResponse::Data::Network::Address }

    # @!attribute logo
    #
    #   @return [String, nil]
    required :logo, String, nil?: true

    # @!attribute member_phone
    #
    #   @return [String, nil]
    required :member_phone, String, nil?: true

    # @!attribute name
    #   Name of the network
    #
    #   @return [String]
    required :name, String

    # @!attribute phone
    #
    #   @return [String]
    required :phone, String

    # @!attribute provider_phone
    #
    #   @return [String, nil]
    required :provider_phone, String, nil?: true

    # @!attribute website
    #   Website of the network
    #
    #   @return [String]
    required :website, String

    # @!attribute edi
    #   Network's EDI
    #
    #   @return [String, nil]
    optional :edi, String, nil?: true

    # @!attribute member_website
    #   Website for members
    #
    #   @return [String, nil]
    optional :member_website, String, nil?: true

    # @!attribute provider_website
    #   Website for providers
    #
    #   @return [String, nil]
    optional :provider_website, String, nil?: true

    response_only do
      # @!attribute id
      #
      #   @return [String]
      required :id, String
    end

    # @!method initialize(id:, address:, logo:, member_phone:, name:, phone:, provider_phone:, website:, edi: nil, member_website: nil, provider_website: nil)
    #   Some parameter documentations has been truncated, see
    #   {VitableConnect::Models::MemberListIDCardsResponse::Data::Network} for more
    #   details.
    #
    #   Provider network shown on the card; null for an rx card
    #
    #   @param id [String]
    #
    #   @param address [VitableConnect::Models::MemberListIDCardsResponse::Data::Network::Address] Shared read serializer for a postal address on public API responses.
    #
    #   @param logo [String, nil]
    #
    #   @param member_phone [String, nil]
    #
    #   @param name [String] Name of the network
    #
    #   @param phone [String]
    #
    #   @param provider_phone [String, nil]
    #
    #   @param website [String] Website of the network
    #
    #   @param edi [String, nil] Network's EDI
    #
    #   @param member_website [String, nil] Website for members
    #
    #   @param provider_website [String, nil] Website for providers

    # @see VitableConnect::Models::MemberListIDCardsResponse::Data::Network#address
    class Address < VitableConnect::Internal::Type::BaseModel
      # @!attribute address_line_1
      #   Primary street address.
      #
      #   @return [String]
      required :address_line_1, String

      # @!attribute address_line_2
      #   Secondary street address (apt, suite, etc.).
      #
      #   @return [String, nil]
      required :address_line_2, String, nil?: true

      # @!attribute city
      #   City name.
      #
      #   @return [String]
      required :city, String

      # @!attribute state
      #   Two-letter state code (e.g. `CA`, `NY`).
      #
      #   @return [String]
      required :state, String

      # @!attribute zipcode
      #   ZIP code (5 or 9 digit).
      #
      #   @return [String]
      required :zipcode, String

      # @!method initialize(address_line_1:, address_line_2:, city:, state:, zipcode:)
      #   Shared read serializer for a postal address on public API responses.
      #
      #   One definition for the address block every public resource emits (employer,
      #   employee, …), so the 5-field shape isn't hand-rolled per endpoint. Read-only: it
      #   renders an already-built address value object (e.g. `AddressDVO`) whose
      #   attributes map 1:1 to these fields.
      #
      #   @param address_line_1 [String] Primary street address.
      #
      #   @param address_line_2 [String, nil] Secondary street address (apt, suite, etc.).
      #
      #   @param city [String] City name.
      #
      #   @param state [String] Two-letter state code (e.g. `CA`, `NY`).
      #
      #   @param zipcode [String] ZIP code (5 or 9 digit).
    end
  end
end

Instance Attribute Details

#benefit_code ⇒ Symbol, ...

  • EBA - Eba Mec
  • VPC - Vpc Enhanced
  • VPC_CORE - Vpc Core
  • MEC - Vpc Mec
  • MEC2 - Mec2
  • MEC_PLUS - Mec Plus
  • MVP - Mvp
  • MVP2 - Mvp2
  • MVPSL - Mvpsl
  • MVPSL2 - Mvpsl2
  • VD - Dental
  • VV - Vision
  • ICHRA - Ichra
  • ICHRA_PREMIUM_PLUS - Ichra Premium Plus
  • ICHRA_REIMBURSEMENT_ONLY - Ichra Reimbursement Only

Parameters:

  • value (VitableConnect::Models::MemberListIDCardsResponse::Data::benefit_code, nil)

Returns:



71
72
73
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 71

optional :benefit_code,
enum: -> { VitableConnect::Models::MemberListIDCardsResponse::Data::BenefitCode },
nil?: true

#card_type ⇒ Symbol, VitableConnect::Models::MemberListIDCardsResponse::Data::CardType

  • medical - medical
  • dental - dental
  • vision - vision
  • rx - rx

Parameters:

  • value (VitableConnect::Models::MemberListIDCardsResponse::Data::card_type)

Returns:



26
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 26

required :card_type, enum: -> { VitableConnect::Models::MemberListIDCardsResponse::Data::CardType }

#carrier_phone ⇒ String?

Carrier phone number on the card; null for an rx card

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


79
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 79

optional :carrier_phone, String, nil?: true

#carrier_website ⇒ String?

Carrier website on the card; null for an rx card

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


85
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 85

optional :carrier_website, String, nil?: true

#claims_payer_display_name ⇒ String?

Claims payer shown on the card

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


91
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 91

optional :claims_payer_display_name, String, nil?: true

#employer_name ⇒ String?

Employer the card's coverage is through; null for an rx card without group info

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


97
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 97

optional :employer_name, String, nil?: true

#general_disclaimer ⇒ String?

General disclaimer text; null for an rx card

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


103
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 103

optional :general_disclaimer, String, nil?: true

#group_id ⇒ String

Group number printed on the card (the rx group id for an rx card)

Parameters:

  • value (String)

Returns:

  • (String) 


32
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 32

required :group_id, String

#group_member_id ⇒ String

Member id printed on the card (the Ventegra cardholder id for an rx card)

Parameters:

  • value (String)

Returns:

  • (String) 


38
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 38

required :group_member_id, String

#member_name ⇒ String

Name of the member the card is issued to

Parameters:

  • value (String)

Returns:

  • (String) 


44
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 44

required :member_name, String

#network ⇒ VitableConnect::Models::MemberListIDCardsResponse::Data::Network?

Provider network shown on the card; null for an rx card

Parameters:

Returns:



109
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 109

optional :network, -> { VitableConnect::Models::MemberListIDCardsResponse::Data::Network }, nil?: true

#nsa_table ⇒ Array<Array<String>>

No Surprises Act cost-sharing table rendered on the card; empty for an rx card

Parameters:

  • value (::Array[::Array[String]])

Returns:

  • (Array<Array<String>>) 


50
51
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 50

required :nsa_table,
VitableConnect::Internal::Type::ArrayOf[VitableConnect::Internal::Type::ArrayOf[String]]

#plan_disclaimer ⇒ String?

Plan-specific disclaimer text; null for an rx card

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


115
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 115

optional :plan_disclaimer, String, nil?: true

#plan_name ⇒ String?

Benefit plan name on the card; null for a consumer-membership rx card

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


121
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 121

optional :plan_name, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 171

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


81
 
# File 'sig/vitable_connect/models/member_list_id_cards_response.rbs', line 81

def to_hash: -> {