Class: SignwellSDK::Models::V1::Document::Field

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

Defined Under Namespace

Modules: Value Classes: Option, Recipient

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(email:, name:) ⇒ Object

Parameters:

  • email (String)
  • name (String) 



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

Instance Attribute Details

#allow_other ⇒ Boolean?

Whether “Other” option is allowed

Returns:

  • (Boolean, nil) 


246
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 246

optional :allow_other, SignwellSDK::Internal::Type::Boolean

#api_id ⇒ String?

Returns:

  • (String, nil) 


251
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 251

optional :api_id, String

#date_format ⇒ Symbol, ...

Date format for date fields. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, MM/DD/YYYY hh:mm:ss a. Default: MM/DD/YYYY

Returns:



258
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 258

optional :date_format, enum: -> { SignwellSDK::DateFormat }

#default_option ⇒ String?

Default selected option

Returns:

  • (String, nil) 


264
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 264

optional :default_option, String

#fixed_width ⇒ Boolean?

Returns:

  • (Boolean, nil) 


269
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 269

optional :fixed_width, SignwellSDK::Internal::Type::Boolean

#height ⇒ String?

Returns:

  • (String, nil) 


274
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 274

optional :height, String

#label ⇒ String?

Returns:

  • (String, nil) 


279
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 279

optional :label, String

#lock_sign_date ⇒ Boolean?

Returns:

  • (Boolean, nil) 


284
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 284

optional :lock_sign_date, SignwellSDK::Internal::Type::Boolean

#name ⇒ String?

Returns:

  • (String, nil) 


289
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 289

optional :name, String, nil?: true

#options ⇒ Array<SignwellSDK::Models::V1::Document::Field::Option>?

Dropdown options (for dropdown/select fields)

Returns:



295
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 295

optional :options, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document::Field::Option] }

#page ⇒ Integer

Returns:

  • (Integer) 


230
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 230

required :page, Integer

#placeholder_name ⇒ String?

Returns:

  • (String, nil) 


300
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 300

optional :placeholder_name, String

#recipient ⇒ SignwellSDK::Models::V1::Document::Field::Recipient?

Returns:



305
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 305

optional :recipient, -> { SignwellSDK::V1::Document::Field::Recipient }

#recipient_id ⇒ String?

Returns:

  • (String, nil) 


310
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 310

optional :recipient_id, String, nil?: true

#required ⇒ Boolean?

Returns:

  • (Boolean, nil) 


315
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 315

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

#signing_elements_group_id ⇒ String?

Returns:

  • (String, nil) 


320
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 320

optional :signing_elements_group_id, String

#type ⇒ Symbol, ...

Type of signing field

Returns:



326
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 326

optional :type, enum: -> { SignwellSDK::FieldType }

#validation ⇒ Symbol, ...

Validation rule for text fields

Returns:



332
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 332

optional :validation, enum: -> { SignwellSDK::TextValidation }

#value ⇒ String, ...

Returns:

  • (String, Boolean, Float, nil) 


337
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 337

optional :value, union: -> { SignwellSDK::V1::Document::Field::Value }, nil?: true

#width ⇒ String?

Returns:

  • (String, nil) 


342
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 342

optional :width, String

#x ⇒ Float

Returns:

  • (Float) 


235
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 235

required :x, Float

#y_ ⇒ Float

Returns:

  • (Float) 


240
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 240

required :y_, Float, api_name: :y