Class: SignwellSDK::Models::V1::DocumentTemplate

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

Overview

See Also:

Defined Under Namespace

Classes: CopiedPlaceholder, Field, Placeholder

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(name:, id: nil, message: nil, placeholder_id: nil, preassigned_recipient_email: nil, preassigned_recipient_name: nil, subject: nil) ⇒ Object

Parameters:

  • name (String)
  • id (String) (defaults to: nil)
  • message (String, nil) (defaults to: nil)
  • placeholder_id (String) (defaults to: nil)
  • preassigned_recipient_email (String) (defaults to: nil)
  • preassigned_recipient_name (String) (defaults to: nil)
  • subject (String, nil) (defaults to: nil) 



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

Instance Attribute Details

#allow_decline ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

optional :allow_decline, SignwellSDK::Internal::Type::Boolean, nil?: true

#allow_reassign ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

optional :allow_reassign, SignwellSDK::Internal::Type::Boolean, nil?: true

#api_application_id ⇒ String?

Returns:

  • (String, nil) 


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

optional :api_application_id, String, nil?: true

#apply_signing_order ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

optional :apply_signing_order, SignwellSDK::Internal::Type::Boolean

#archived ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

optional :archived, SignwellSDK::Internal::Type::Boolean

#checkbox_groups ⇒ Array<SignwellSDK::Models::CheckboxGroupInfo>?

Returns:



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

optional :checkbox_groups, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::CheckboxGroupInfo] }

#copied_placeholders ⇒ Array<SignwellSDK::Models::V1::DocumentTemplate::CopiedPlaceholder>?

Returns:



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

optional :copied_placeholders,
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentTemplate::CopiedPlaceholder] }

#created_at ⇒ Time?

Returns:

  • (Time, nil) 


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

optional :created_at, Time

#custom_requester_email ⇒ String?

Returns:

  • (String, nil) 


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

optional :custom_requester_email, String, nil?: true

#custom_requester_name ⇒ String?

Returns:

  • (String, nil) 


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

optional :custom_requester_name, String, nil?: true

#decline_redirect_url ⇒ String?

Returns:

  • (String, nil) 


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

optional :decline_redirect_url, String, nil?: true

#expires_in ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :expires_in, Integer, nil?: true

#fields ⇒ Array<Array<SignwellSDK::Models::V1::DocumentTemplate::Field>>?

Returns:



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

optional :fields,
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentTemplate::Field]] }

#files ⇒ Array<SignwellSDK::Models::FileInfo>?

Returns:



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

optional :files, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::FileInfo] }

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#labels ⇒ Array<SignwellSDK::Models::LabelInfo>?

Returns:



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

optional :labels, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::LabelInfo] }

#language ⇒ String?

Returns:

  • (String, nil) 


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

optional :language, String

#message ⇒ String?

Returns:

  • (String, nil) 


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

optional :message, String

#metadata ⇒ Hash{Symbol=>String}?

Returns:

  • (Hash{Symbol=>String}, nil) 


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

optional :metadata, SignwellSDK::Internal::Type::HashOf[String], nil?: true

#name ⇒ String?

Returns:

  • (String, nil) 


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

optional :name, String

#placeholders ⇒ Array<SignwellSDK::Models::V1::DocumentTemplate::Placeholder>?

Returns:



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

optional :placeholders,
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentTemplate::Placeholder] }

#redirect_url ⇒ String?

Returns:

  • (String, nil) 


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

optional :redirect_url, String, nil?: true

#reminders ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

optional :reminders, SignwellSDK::Internal::Type::Boolean, nil?: true

#requester_email_address ⇒ String?

Returns:

  • (String, nil) 


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

optional :requester_email_address, String

#status ⇒ String?

Returns:

  • (String, nil) 


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

optional :status, String

#subject ⇒ String?

Returns:

  • (String, nil) 


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

optional :subject, String

#template_link ⇒ String?

Returns:

  • (String, nil) 


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

optional :template_link, String

#updated_at ⇒ Time?

Returns:

  • (Time, nil) 


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

optional :updated_at, Time

Class Method Details

.variants ⇒ Array(String, Boolean, Float)

Returns:

  • (Array(String, Boolean, Float)) 



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