Skip to content

Latest commit

 

History

History
136 lines (130 loc) · 11.1 KB

EzsignfoldertypeRequestV3.md

File metadata and controls

136 lines (130 loc) · 11.1 KB

EzmaxApi::EzsignfoldertypeRequestV3

Properties

Name Type Description Notes
pki_ezsignfoldertype_id Integer The unique ID of the Ezsignfoldertype. [optional]
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_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
fki_font_id_annotation Integer The unique ID of the Font [optional]
fki_font_id_formfield Integer The unique ID of the Font [optional]
fki_font_id_signature Integer The unique ID of the Font [optional]
fki_pdfalevel_id_convert Integer The unique ID of the Pdfalevel [optional]
a_fki_pdfalevel_id Array<Integer> [optional]
a_fki_userlogintype_id Array<Integer>
a_fki_usergroup_id_all Array<Integer> [optional]
a_fki_usergroup_id_restricted Array<Integer> [optional]
a_fki_usergroup_id_template Array<Integer> [optional]
e_ezsignfoldertype_documentdependency FieldEEzsignfoldertypeDocumentdependency [optional]
s_email_address_signed String The email address. [optional]
s_email_address_summary String The email address. [optional]
e_ezsignfoldertype_pdfarequirement FieldEEzsignfoldertypePdfarequirement [optional]
e_ezsignfoldertype_pdfanoncompliantaction FieldEEzsignfoldertypePdfanoncompliantaction [optional]
e_ezsignfoldertype_privacylevel FieldEEzsignfoldertypePrivacylevel
i_ezsignfoldertype_fontsizeannotation Integer Font size for annotations [optional]
i_ezsignfoldertype_fontsizeformfield Integer Font size for form fields [optional]
i_ezsignfoldertype_sendreminderfirstdays Integer The number of days before the the first reminder sending [optional]
i_ezsignfoldertype_sendreminderotherdays Integer The number of days after the first reminder sending [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_prematurelyendautomatically Boolean Wheter if document will be ended prematurely after Ezsignfolder expires. [optional]
i_ezsignfoldertype_prematurelyendautomaticallydays Integer Number of days between Ezsignfolder expiration and automatic prematurely end of Ezsigndocuments. [optional]
b_ezsignfoldertype_automaticsignature Boolean Whether we allow the automatic signature by an User [optional]
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_logrecipientinproof Boolean Whether we log recipient of signed document in proof [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_reassigngroup Boolean Wheter if Reassignment of signatures of the groups to which the user belongs is authorized by a user to himself [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
e_ezsignfoldertype_signeraccess FieldEEzsignfoldertypeSigneraccess [optional]
b_ezsignfoldertype_isactive Boolean Whether the Ezsignfoldertype is active or not

Example

require 'Ezmaxapi'

instance = EzmaxApi::EzsignfoldertypeRequestV3.new(
  pki_ezsignfoldertype_id: 5,
  obj_ezsignfoldertype_name: null,
  fki_branding_id: 78,
  fki_billingentityinternal_id: 1,
  fki_ezsigntsarequirement_id: 1,
  fki_font_id_annotation: 1,
  fki_font_id_formfield: 1,
  fki_font_id_signature: 1,
  fki_pdfalevel_id_convert: 102,
  a_fki_pdfalevel_id: null,
  a_fki_userlogintype_id: null,
  a_fki_usergroup_id_all: null,
  a_fki_usergroup_id_restricted: null,
  a_fki_usergroup_id_template: null,
  e_ezsignfoldertype_documentdependency: null,
  s_email_address_signed: email@example.com,
  s_email_address_summary: email@example.com,
  e_ezsignfoldertype_pdfarequirement: null,
  e_ezsignfoldertype_pdfanoncompliantaction: null,
  e_ezsignfoldertype_privacylevel: null,
  i_ezsignfoldertype_fontsizeannotation: 10,
  i_ezsignfoldertype_fontsizeformfield: 12,
  i_ezsignfoldertype_sendreminderfirstdays: 30,
  i_ezsignfoldertype_sendreminderotherdays: 30,
  i_ezsignfoldertype_archivaldays: 30,
  e_ezsignfoldertype_disposal: null,
  e_ezsignfoldertype_completion: null,
  i_ezsignfoldertype_disposaldays: 365,
  i_ezsignfoldertype_deadlinedays: 5,
  b_ezsignfoldertype_prematurelyendautomatically: true,
  i_ezsignfoldertype_prematurelyendautomaticallydays: 5,
  b_ezsignfoldertype_automaticsignature: false,
  b_ezsignfoldertype_delegate: true,
  b_ezsignfoldertype_discussion: true,
  b_ezsignfoldertype_logrecipientinproof: false,
  b_ezsignfoldertype_reassignezsignsigner: true,
  b_ezsignfoldertype_reassignuser: true,
  b_ezsignfoldertype_reassigngroup: 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,
  e_ezsignfoldertype_signeraccess: null,
  b_ezsignfoldertype_isactive: true
)