Class: SignwellSDK::Models::V1::DocumentTemplate::Field::Option

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/signwell_sdk/models/v1/document_template.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(page:, x:, y_:, allow_other: nil, api_id: nil, date_format: nil, default_option: nil, fixed_width: nil, height: nil, label: nil, lock_sign_date: nil, name: nil, options: nil, placeholder_name: nil, recipient: nil, recipient_id: nil, required: nil, signing_elements_group_id: nil, type: nil, validation: nil, value: nil, width: nil) ⇒ Object

Some parameter documentations has been truncated, see SignwellSDK::Models::V1::DocumentTemplate::Field for more details.

Parameters:

  • page (Integer)
  • x (Float)
  • y_ (Float)
  • allow_other (Boolean) (defaults to: nil) —

    Whether “Other” option is allowed

  • api_id (String) (defaults to: nil)
  • date_format (Symbol, SignwellSDK::Models::DateFormat) (defaults to: nil) —

    Date format for date fields. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, M

  • default_option (String) (defaults to: nil) —

    Default selected option

  • fixed_width (Boolean) (defaults to: nil)
  • height (String) (defaults to: nil)
  • label (String) (defaults to: nil)
  • lock_sign_date (Boolean) (defaults to: nil)
  • name (String, nil) (defaults to: nil)
  • options (Array<SignwellSDK::Models::V1::DocumentTemplate::Field::Option>) (defaults to: nil) —

    Dropdown options (for dropdown/select fields)

  • placeholder_name (String) (defaults to: nil)
  • recipient (SignwellSDK::Models::V1::DocumentTemplate::Field::Recipient) (defaults to: nil)
  • recipient_id (String, nil) (defaults to: nil)
  • required (Boolean) (defaults to: nil)
  • signing_elements_group_id (String) (defaults to: nil)
  • type (Symbol, SignwellSDK::Models::FieldType) (defaults to: nil) —

    Type of signing field

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

    Validation rule for text fields

  • value (String, Boolean, Float, nil) (defaults to: nil)
  • width (String) (defaults to: nil) 


394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/signwell_sdk/models/v1/document_template.rb', line 394

class Option < SignwellSDK::Internal::Type::BaseModel
  # @!attribute api_id
  #
  #   @return [String, nil]
  optional :api_id, String

  # @!attribute is_other
  #
  #   @return [Boolean, nil]
  optional :is_other, SignwellSDK::Internal::Type::Boolean

  # @!attribute name
  #
  #   @return [String, nil]
  optional :name, String

  # @!method initialize(api_id: nil, is_other: nil, name: nil)
  #   @param api_id [String]
  #   @param is_other [Boolean]
  #   @param name [String]
end

Instance Attribute Details

#api_id ⇒ String?

Returns:

  • (String, nil) 


398
 
# File 'lib/signwell_sdk/models/v1/document_template.rb', line 398

optional :api_id, String

#is_other ⇒ Boolean?

Returns:

  • (Boolean, nil) 


403
 
# File 'lib/signwell_sdk/models/v1/document_template.rb', line 403

optional :is_other, SignwellSDK::Internal::Type::Boolean

#name ⇒ String?

Returns:

  • (String, nil) 


408
 
# File 'lib/signwell_sdk/models/v1/document_template.rb', line 408

optional :name, String