Class: SignwellSDK::Models::CheckboxGroupInfo

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/signwell_sdk/models/checkbox_group_info.rb

Instance Attribute 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(id:, checkbox_ids:, required:, group_name: nil, min_value: nil, recipient_id: nil, validation: nil) ⇒ Object

Checkbox group configuration

Parameters:

  • id (String) —

    Checkbox group ID

  • checkbox_ids (Array<String>) —

    IDs of checkboxes in this group

  • required (Boolean) —

    Whether at least one checkbox must be checked

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

    Name of the checkbox group

  • min_value (Integer) (defaults to: nil) —

    Minimum number of checkboxes to check

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

    Recipient ID associated with the group

  • validation (Symbol, SignwellSDK::Models::CheckboxValidation, nil) (defaults to: nil) —

    Validation rule for checkbox groups




# File 'lib/signwell_sdk/models/checkbox_group_info.rb', line 48

Instance Attribute Details

#checkbox_ids ⇒ Array<String>

IDs of checkboxes in this group

Returns:

  • (Array<String>) 


16
 
# File 'lib/signwell_sdk/models/checkbox_group_info.rb', line 16

required :checkbox_ids, SignwellSDK::Internal::Type::ArrayOf[String]

#group_name ⇒ String?

Name of the checkbox group

Returns:

  • (String, nil) 


28
 
# File 'lib/signwell_sdk/models/checkbox_group_info.rb', line 28

optional :group_name, String, nil?: true

#id ⇒ String

Checkbox group ID

Returns:

  • (String) 


10
 
# File 'lib/signwell_sdk/models/checkbox_group_info.rb', line 10

required :id, String

#min_value ⇒ Integer?

Minimum number of checkboxes to check

Returns:

  • (Integer, nil) 


34
 
# File 'lib/signwell_sdk/models/checkbox_group_info.rb', line 34

optional :min_value, Integer

#recipient_id ⇒ String?

Recipient ID associated with the group

Returns:

  • (String, nil) 


40
 
# File 'lib/signwell_sdk/models/checkbox_group_info.rb', line 40

optional :recipient_id, String, nil?: true

#required ⇒ Boolean

Whether at least one checkbox must be checked

Returns:

  • (Boolean) 


22
 
# File 'lib/signwell_sdk/models/checkbox_group_info.rb', line 22

required :required, SignwellSDK::Internal::Type::Boolean

#validation ⇒ Symbol, ...

Validation rule for checkbox groups

Returns:



46
 
# File 'lib/signwell_sdk/models/checkbox_group_info.rb', line 46

optional :validation, enum: -> { SignwellSDK::CheckboxValidation }, nil?: true