Class: SignwellSDK::Models::V1::Document::AttachmentRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/signwell_sdk/models/v1/document.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:, test_mode:, allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, archived: nil, attachment_requests: nil, checkbox_groups: nil, copied_contacts: nil, created_at: nil, custom_requester_email: nil, custom_requester_name: nil, decline_redirect_url: nil, embedded: nil, embedded_edit_url: nil, embedded_preview_url: nil, expires_in: nil, fields: nil, files: nil, labels: nil, language: nil, message: nil, metadata: nil, name: nil, recipients: nil, redirect_url: nil, reminders: nil, requester_email_address: nil, status: nil, subject: nil, updated_at: nil) ⇒ Object

Parameters:

  • id (String)
  • test_mode (Boolean)
  • allow_decline (Boolean, nil) (defaults to: nil)
  • allow_reassign (Boolean, nil) (defaults to: nil)
  • api_application_id (String, nil) (defaults to: nil)
  • apply_signing_order (Boolean) (defaults to: nil)
  • archived (Boolean) (defaults to: nil)
  • attachment_requests (Array<SignwellSDK::Models::V1::Document::AttachmentRequest>) (defaults to: nil)
  • checkbox_groups (Array<SignwellSDK::Models::CheckboxGroupInfo>) (defaults to: nil)
  • copied_contacts (Array<SignwellSDK::Models::CopiedContactInfo>) (defaults to: nil)
  • created_at (Time) (defaults to: nil)
  • custom_requester_email (String, nil) (defaults to: nil)
  • custom_requester_name (String, nil) (defaults to: nil)
  • decline_redirect_url (String, nil) (defaults to: nil)
  • embedded (Boolean) (defaults to: nil)
  • embedded_edit_url (String) (defaults to: nil)
  • embedded_preview_url (String, nil) (defaults to: nil)
  • expires_in (Integer) (defaults to: nil)
  • fields (Array<Array<SignwellSDK::Models::V1::Document::Field>>) (defaults to: nil)
  • files (Array<SignwellSDK::Models::FileInfo>) (defaults to: nil)
  • labels (Array<SignwellSDK::Models::LabelInfo>) (defaults to: nil)
  • language (String) (defaults to: nil)
  • message (String) (defaults to: nil)
  • metadata (Hash{Symbol=>String}, nil) (defaults to: nil)
  • name (String) (defaults to: nil)
  • recipients (Array<SignwellSDK::Models::V1::Document::Recipient>) (defaults to: nil)
  • redirect_url (String, nil) (defaults to: nil)
  • reminders (Boolean) (defaults to: nil)
  • requester_email_address (String) (defaults to: nil)
  • status (String) (defaults to: nil)
  • subject (String) (defaults to: nil)
  • updated_at (Time) (defaults to: nil) 


204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/signwell_sdk/models/v1/document.rb', line 204

class AttachmentRequest < SignwellSDK::Internal::Type::BaseModel
  # @!attribute name
  #
  #   @return [String]
  required :name, String

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

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

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

Instance Attribute Details

#name ⇒ String

Returns:

  • (String) 


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

required :name, String

#recipient_id ⇒ String

Returns:

  • (String) 


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

required :recipient_id, String

#required ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

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