lib/docusign_esign/models/document.rb in docusign_esign-2.13.0.rc1 vs lib/docusign_esign/models/document.rb in docusign_esign-3.0.0.rc1
- old
+ new
@@ -1,35 +1,36 @@
=begin
#DocuSign REST API
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Generated by: https://github.com/swagger-api/swagger-codegen.git
=end
require 'date'
module DocuSign_eSign
+
class Document
# Reserved: TBD
attr_accessor :apply_anchor_tabs
- # Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
- attr_accessor :authoritative_copy
-
#
attr_accessor :display
# The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.
attr_accessor :document_base64
#
attr_accessor :document_fields
+ #
+ attr_accessor :document_group
+
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
attr_accessor :document_id
# When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.
attr_accessor :encrypted_with_key_manager
@@ -53,21 +54,32 @@
#
attr_accessor :order
#
+ attr_accessor :page_count
+
+ #
attr_accessor :pages
#
+ attr_accessor :page_sizes
+
+ #
attr_accessor :password
+ #
+ attr_accessor :pdf_form_field_option
+
# The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}].
attr_accessor :remote_url
#
attr_accessor :signer_must_acknowledge
+ attr_accessor :tabs
+
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
attr_accessor :template_locked
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
attr_accessor :template_required
@@ -76,31 +88,36 @@
attr_accessor :transform_pdf_fields
#
attr_accessor :uri
+
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'apply_anchor_tabs' => :'applyAnchorTabs',
- :'authoritative_copy' => :'authoritativeCopy',
:'display' => :'display',
:'document_base64' => :'documentBase64',
:'document_fields' => :'documentFields',
+ :'document_group' => :'documentGroup',
:'document_id' => :'documentId',
:'encrypted_with_key_manager' => :'encryptedWithKeyManager',
:'file_extension' => :'fileExtension',
:'file_format_hint' => :'fileFormatHint',
:'html_definition' => :'htmlDefinition',
:'include_in_download' => :'includeInDownload',
:'match_boxes' => :'matchBoxes',
:'name' => :'name',
:'order' => :'order',
+ :'page_count' => :'pageCount',
:'pages' => :'pages',
+ :'page_sizes' => :'pageSizes',
:'password' => :'password',
+ :'pdf_form_field_option' => :'pdfFormFieldOption',
:'remote_url' => :'remoteUrl',
:'signer_must_acknowledge' => :'signerMustAcknowledge',
+ :'tabs' => :'tabs',
:'template_locked' => :'templateLocked',
:'template_required' => :'templateRequired',
:'transform_pdf_fields' => :'transformPdfFields',
:'uri' => :'uri'
}
@@ -108,27 +125,31 @@
# Attribute type mapping.
def self.swagger_types
{
:'apply_anchor_tabs' => :'String',
- :'authoritative_copy' => :'BOOLEAN',
:'display' => :'String',
:'document_base64' => :'String',
:'document_fields' => :'Array<NameValue>',
+ :'document_group' => :'String',
:'document_id' => :'String',
:'encrypted_with_key_manager' => :'String',
:'file_extension' => :'String',
:'file_format_hint' => :'String',
:'html_definition' => :'DocumentHtmlDefinition',
:'include_in_download' => :'String',
:'match_boxes' => :'Array<MatchBox>',
:'name' => :'String',
:'order' => :'String',
+ :'page_count' => :'String',
:'pages' => :'String',
+ :'page_sizes' => :'Array<PageSize>',
:'password' => :'String',
+ :'pdf_form_field_option' => :'String',
:'remote_url' => :'String',
:'signer_must_acknowledge' => :'String',
+ :'tabs' => :'Tabs',
:'template_locked' => :'String',
:'template_required' => :'String',
:'transform_pdf_fields' => :'String',
:'uri' => :'String'
}
@@ -138,20 +159,16 @@
# @param [Hash] attributes Model attributes in the form of hash
def initialize(attributes = {})
return unless attributes.is_a?(Hash)
# convert string to symbol for hash key
- attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
if attributes.has_key?(:'applyAnchorTabs')
self.apply_anchor_tabs = attributes[:'applyAnchorTabs']
end
- if attributes.has_key?(:'authoritativeCopy')
- self.authoritative_copy = attributes[:'authoritativeCopy']
- end
-
if attributes.has_key?(:'display')
self.display = attributes[:'display']
end
if attributes.has_key?(:'documentBase64')
@@ -162,10 +179,14 @@
if (value = attributes[:'documentFields']).is_a?(Array)
self.document_fields = value
end
end
+ if attributes.has_key?(:'documentGroup')
+ self.document_group = attributes[:'documentGroup']
+ end
+
if attributes.has_key?(:'documentId')
self.document_id = attributes[:'documentId']
end
if attributes.has_key?(:'encryptedWithKeyManager')
@@ -200,26 +221,44 @@
if attributes.has_key?(:'order')
self.order = attributes[:'order']
end
+ if attributes.has_key?(:'pageCount')
+ self.page_count = attributes[:'pageCount']
+ end
+
if attributes.has_key?(:'pages')
self.pages = attributes[:'pages']
end
+ if attributes.has_key?(:'pageSizes')
+ if (value = attributes[:'pageSizes']).is_a?(Array)
+ self.page_sizes = value
+ end
+ end
+
if attributes.has_key?(:'password')
self.password = attributes[:'password']
end
+ if attributes.has_key?(:'pdfFormFieldOption')
+ self.pdf_form_field_option = attributes[:'pdfFormFieldOption']
+ end
+
if attributes.has_key?(:'remoteUrl')
self.remote_url = attributes[:'remoteUrl']
end
if attributes.has_key?(:'signerMustAcknowledge')
self.signer_must_acknowledge = attributes[:'signerMustAcknowledge']
end
+ if attributes.has_key?(:'tabs')
+ self.tabs = attributes[:'tabs']
+ end
+
if attributes.has_key?(:'templateLocked')
self.template_locked = attributes[:'templateLocked']
end
if attributes.has_key?(:'templateRequired')
@@ -231,48 +270,53 @@
end
if attributes.has_key?(:'uri')
self.uri = attributes[:'uri']
end
+
end
# Show invalid properties with the reasons. Usually used together with valid?
- # @return Array for valid properties with the reasons
+ # @return Array for valid properies with the reasons
def list_invalid_properties
invalid_properties = Array.new
- invalid_properties
+ return invalid_properties
end
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
def valid?
- true
+ return true
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
def ==(o)
return true if self.equal?(o)
self.class == o.class &&
apply_anchor_tabs == o.apply_anchor_tabs &&
- authoritative_copy == o.authoritative_copy &&
display == o.display &&
document_base64 == o.document_base64 &&
document_fields == o.document_fields &&
+ document_group == o.document_group &&
document_id == o.document_id &&
encrypted_with_key_manager == o.encrypted_with_key_manager &&
file_extension == o.file_extension &&
file_format_hint == o.file_format_hint &&
html_definition == o.html_definition &&
include_in_download == o.include_in_download &&
match_boxes == o.match_boxes &&
name == o.name &&
order == o.order &&
+ page_count == o.page_count &&
pages == o.pages &&
+ page_sizes == o.page_sizes &&
password == o.password &&
+ pdf_form_field_option == o.pdf_form_field_option &&
remote_url == o.remote_url &&
signer_must_acknowledge == o.signer_must_acknowledge &&
+ tabs == o.tabs &&
template_locked == o.template_locked &&
template_required == o.template_required &&
transform_pdf_fields == o.transform_pdf_fields &&
uri == o.uri
end
@@ -284,24 +328,24 @@
end
# Calculates hash code according to all attributes.
# @return [Fixnum] Hash code
def hash
- [apply_anchor_tabs, authoritative_copy, display, document_base64, document_fields, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, match_boxes, name, order, pages, password, remote_url, signer_must_acknowledge, template_locked, template_required, transform_pdf_fields, uri].hash
+ [apply_anchor_tabs, display, document_base64, document_fields, document_group, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, match_boxes, name, order, page_count, pages, page_sizes, password, pdf_form_field_option, remote_url, signer_must_acknowledge, tabs, template_locked, template_required, transform_pdf_fields, uri].hash
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
def build_from_hash(attributes)
return nil unless attributes.is_a?(Hash)
self.class.swagger_types.each_pair do |key, type|
if type =~ /\AArray<(.*)>/i
- # check to ensure the input is an array given that the attribute
+ # check to ensure the input is an array given that the the attribute
# is documented as an array but the input is not
if attributes[self.class.attribute_map[key]].is_a?(Array)
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
end
elsif !attributes[self.class.attribute_map[key]].nil?
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
end # or else data not found in attributes(hash), not an issue as the data can be optional
end
@@ -379,11 +423,11 @@
# For object, use to_hash. Otherwise, just return the value
# @param [Object] value Any valid value
# @return [Hash] Returns the value in the form of hash
def _to_hash(value)
if value.is_a?(Array)
- value.compact.map { |v| _to_hash(v) }
+ value.compact.map{ |v| _to_hash(v) }
elsif value.is_a?(Hash)
{}.tap do |hash|
value.each { |k, v| hash[k] = _to_hash(v) }
end
elsif value.respond_to? :to_hash
@@ -392,6 +436,7 @@
value
end
end
end
+
end