Skip to content

Latest commit

 

History

History
114 lines (108 loc) · 9.3 KB

EzsignfoldertypeResponseCompound.md

File metadata and controls

114 lines (108 loc) · 9.3 KB
Raw

EzmaxApi::EzsignfoldertypeResponseCompound

Properties

Name Type Description Notes
pki_ezsignfoldertype_id Integer The unique ID of the Ezsignfoldertype.
obj_ezsignfoldertype_name MultilingualEzsignfoldertypeName
fki_branding_id Integer The unique ID of the Branding
fki_billingentityinternal_id Integer The unique ID of the Billingentityinternal. [optional]
fki_usergroup_id Integer The unique ID of the Usergroup [optional]
fki_usergroup_id_restricted Integer The unique ID of the Usergroup [optional]
fki_ezsigntsarequirement_id Integer The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: Value
s_branding_description_x String The Description of the Branding in the language of the requester
s_billingentityinternal_description_x String The description of the Billingentityinternal in the language of the requester [optional]
s_ezsigntsarequirement_description_x String The description of the Ezsigntsarequirement in the language of the requester [optional]
s_email_address_signed String The email address. [optional]
s_email_address_summary String The email address. [optional]
s_usergroup_name_x String The Name of the Usergroup in the language of the requester [optional]
s_usergroup_name_x_restricted String The Name of the Usergroup in the language of the requester [optional]
e_ezsignfoldertype_privacylevel FieldEEzsignfoldertypePrivacylevel
e_ezsignfoldertype_sendreminderfrequency FieldEEzsignfoldertypeSendreminderfrequency [optional]
i_ezsignfoldertype_archivaldays Integer The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype
e_ezsignfoldertype_disposal FieldEEzsignfoldertypeDisposal
e_ezsignfoldertype_completion FieldEEzsignfoldertypeCompletion
i_ezsignfoldertype_disposaldays Integer The number of days after the archival before the disposal of the Ezsignfolder [optional]
i_ezsignfoldertype_deadlinedays Integer The number of days to get all Ezsignsignatures
b_ezsignfoldertype_delegate Boolean Wheter if delegation of signature is allowed to another user or not [optional]
b_ezsignfoldertype_discussion Boolean Wheter if creating a new Discussion is allowed or not [optional]
b_ezsignfoldertype_reassignezsignsigner Boolean Wheter if Reassignment of signature is allowed by a signatory to another signatory or not [optional]
b_ezsignfoldertype_reassignuser Boolean Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not [optional]
b_ezsignfoldertype_sendsignedtoezsignsigner Boolean Whether we send an email to Ezsignsigner when document is completed [optional]
b_ezsignfoldertype_sendsignedtouser Boolean Whether we send an email to User who signed when document is completed [optional]
b_ezsignfoldertype_sendattachmentezsignsigner Boolean Whether we send the Ezsigndocument in the email to Ezsignsigner [optional]
b_ezsignfoldertype_sendproofezsignsigner Boolean Whether we send the proof in the email to Ezsignsigner [optional]
b_ezsignfoldertype_sendattachmentuser Boolean Whether we send the Ezsigndocument in the email to User [optional]
b_ezsignfoldertype_sendproofuser Boolean Whether we send the proof in the email to User [optional]
b_ezsignfoldertype_sendproofemail Boolean Whether we send the proof in the email to external recipient [optional]
b_ezsignfoldertype_allowdownloadattachmentezsignsigner Boolean Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner [optional]
b_ezsignfoldertype_allowdownloadproofezsignsigner Boolean Whether we allow the proof to be downloaded by an Ezsignsigner [optional]
b_ezsignfoldertype_sendproofreceivealldocument Boolean Whether we send the proof to user and Ezsignsigner who receive all documents. [optional]
b_ezsignfoldertype_sendsignedtodocumentowner Boolean Whether we send the signed Ezsigndocument to the Ezsigndocument's owner
b_ezsignfoldertype_sendsignedtofolderowner Boolean Whether we send the signed Ezsigndocument to the Ezsignfolder's owner
b_ezsignfoldertype_sendsignedtofullgroup Boolean Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders [optional]
b_ezsignfoldertype_sendsignedtolimitedgroup Boolean THIS FIELD WILL BE DELETED. Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders [optional]
b_ezsignfoldertype_sendsignedtocolleague Boolean Whether we send the signed Ezsigndocument to the colleagues
b_ezsignfoldertype_sendsummarytodocumentowner Boolean Whether we send the summary to the Ezsigndocument's owner
b_ezsignfoldertype_sendsummarytofolderowner Boolean Whether we send the summary to the Ezsignfolder's owner
b_ezsignfoldertype_sendsummarytofullgroup Boolean Whether we send the summary to the Usergroup that has acces to all Ezsignfolders [optional]
b_ezsignfoldertype_sendsummarytolimitedgroup Boolean Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders [optional]
b_ezsignfoldertype_sendsummarytocolleague Boolean Whether we send the summary to the colleagues
b_ezsignfoldertype_isactive Boolean Whether the Ezsignfoldertype is active or not
a_obj_userlogintype Array<UserlogintypeResponse>
a_fki_user_id_signed Array<Integer> [optional]
a_fki_user_id_summary Array<Integer> [optional]

Example

require 'Ezmaxapi'

instance = EzmaxApi::EzsignfoldertypeResponseCompound.new(
  pki_ezsignfoldertype_id: 5,
  obj_ezsignfoldertype_name: null,
  fki_branding_id: 78,
  fki_billingentityinternal_id: 1,
  fki_usergroup_id: 2,
  fki_usergroup_id_restricted: 2,
  fki_ezsigntsarequirement_id: 1,
  s_branding_description_x: Company X,
  s_billingentityinternal_description_x: Default,
  s_ezsigntsarequirement_description_x: No,
  s_email_address_signed: email@example.com,
  s_email_address_summary: email@example.com,
  s_usergroup_name_x: Administration,
  s_usergroup_name_x_restricted: Administration,
  e_ezsignfoldertype_privacylevel: null,
  e_ezsignfoldertype_sendreminderfrequency: null,
  i_ezsignfoldertype_archivaldays: 30,
  e_ezsignfoldertype_disposal: null,
  e_ezsignfoldertype_completion: null,
  i_ezsignfoldertype_disposaldays: 365,
  i_ezsignfoldertype_deadlinedays: 5,
  b_ezsignfoldertype_delegate: true,
  b_ezsignfoldertype_discussion: true,
  b_ezsignfoldertype_reassignezsignsigner: true,
  b_ezsignfoldertype_reassignuser: true,
  b_ezsignfoldertype_sendsignedtoezsignsigner: false,
  b_ezsignfoldertype_sendsignedtouser: false,
  b_ezsignfoldertype_sendattachmentezsignsigner: false,
  b_ezsignfoldertype_sendproofezsignsigner: false,
  b_ezsignfoldertype_sendattachmentuser: false,
  b_ezsignfoldertype_sendproofuser: false,
  b_ezsignfoldertype_sendproofemail: false,
  b_ezsignfoldertype_allowdownloadattachmentezsignsigner: false,
  b_ezsignfoldertype_allowdownloadproofezsignsigner: false,
  b_ezsignfoldertype_sendproofreceivealldocument: false,
  b_ezsignfoldertype_sendsignedtodocumentowner: false,
  b_ezsignfoldertype_sendsignedtofolderowner: false,
  b_ezsignfoldertype_sendsignedtofullgroup: false,
  b_ezsignfoldertype_sendsignedtolimitedgroup: false,
  b_ezsignfoldertype_sendsignedtocolleague: false,
  b_ezsignfoldertype_sendsummarytodocumentowner: false,
  b_ezsignfoldertype_sendsummarytofolderowner: false,
  b_ezsignfoldertype_sendsummarytofullgroup: false,
  b_ezsignfoldertype_sendsummarytolimitedgroup: false,
  b_ezsignfoldertype_sendsummarytocolleague: false,
  b_ezsignfoldertype_isactive: true,
  a_obj_userlogintype: null,
  a_fki_user_id_signed: null,
  a_fki_user_id_summary: null
)