lib/docusign_esign/models/draw.rb in docusign_esign-3.18.0 vs lib/docusign_esign/models/draw.rb in docusign_esign-3.19.0
- old
+ new
@@ -10,208 +10,248 @@
=end
require 'date'
module DocuSign_eSign
+ # A tab that allows the recipient to add a free-form drawing to the document.
class Draw
#
attr_accessor :allow_signer_upload
#
attr_accessor :anchor_allow_white_space_in_characters
+ # Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
attr_accessor :anchor_allow_white_space_in_characters_metadata
# When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
attr_accessor :anchor_case_sensitive
+ # Metadata that indicates whether the `anchorCaseSensitive` property is editable.
attr_accessor :anchor_case_sensitive_metadata
# Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
attr_accessor :anchor_horizontal_alignment
+ # Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
attr_accessor :anchor_horizontal_alignment_metadata
# When set to **true**, this tab is ignored if anchorString is not found in the document.
attr_accessor :anchor_ignore_if_not_present
+ # Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
attr_accessor :anchor_ignore_if_not_present_metadata
# When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
attr_accessor :anchor_match_whole_word
+ # Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
attr_accessor :anchor_match_whole_word_metadata
# Anchor text information for a radio button.
attr_accessor :anchor_string
+ # Metadata that indicates whether the `anchorString` property is editable.
attr_accessor :anchor_string_metadata
#
attr_accessor :anchor_tab_processor_version
+ # Reserved for DocuSign.
attr_accessor :anchor_tab_processor_version_metadata
# Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
attr_accessor :anchor_units
+ # Metadata that indicates whether the `anchorUnits` property is editable.
attr_accessor :anchor_units_metadata
# Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
attr_accessor :anchor_x_offset
+ # Metadata that indicates whether the `anchorXOffset` property is editable.
attr_accessor :anchor_x_offset_metadata
# Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
attr_accessor :anchor_y_offset
+ # Metadata that indicates whether the `anchorYOffset` property is editable.
attr_accessor :anchor_y_offset_metadata
#
attr_accessor :caption
attr_accessor :caption_metadata
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
attr_accessor :conditional_parent_label
+ # Metadata that indicates whether the `conditionalParentLabel` property is editable.
attr_accessor :conditional_parent_label_metadata
# For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
attr_accessor :conditional_parent_value
+ # Metadata that indicates whether the `conditionalParentValue` property is editable.
attr_accessor :conditional_parent_value_metadata
# The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
attr_accessor :custom_tab_id
+ # Metadata that indicates whether the `customTabId` property is editable.
attr_accessor :custom_tab_id_metadata
# 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
+ # Metadata that indicates whether the `documentId` property is editable.
attr_accessor :document_id_metadata
+ # This object describes errors that occur. It is only valid for responses and ignored in requests.
attr_accessor :error_details
#
attr_accessor :form_order
+ # Metadata that indicates whether the `formOrder` property is editable.
attr_accessor :form_order_metadata
#
attr_accessor :form_page_label
+ # Metadata that indicates whether the `formPageLabel` property is editable.
attr_accessor :form_page_label_metadata
#
attr_accessor :form_page_number
+ # Metadata that indicates whether the `fromPageNumber` property is editable.
attr_accessor :form_page_number_metadata
# Height of the tab in pixels.
attr_accessor :height
+ # Metadata that indicates whether the `height` property is editable.
attr_accessor :height_metadata
# When set to **true**, the signer cannot change the data of the custom tab.
attr_accessor :locked
+ # Metadata that indicates whether the `locked` property is editable.
attr_accessor :locked_metadata
+ # Contains the information necessary to map the tab to a field in SalesForce.
attr_accessor :merge_field
#
attr_accessor :merge_field_xml
# Specifies the page number on which the tab is located.
attr_accessor :page_number
+ # Metadata that indicates whether the `pageNumber` property is editable.
attr_accessor :page_number_metadata
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
attr_accessor :recipient_id
#
attr_accessor :recipient_id_guid
+ # Metadata that indicates whether the `recipientIdGuid` property is editable.
attr_accessor :recipient_id_guid_metadata
+ # Metadata that indicates whether the `recipientId` property is editable.
attr_accessor :recipient_id_metadata
# When set to **true**, the signer is required to fill out this tab
attr_accessor :required
+ # Metadata that indicates whether the `required` property is editable.
attr_accessor :required_metadata
# When set to **true**, this custom tab is shared.
attr_accessor :shared
+ # Metadata that indicates whether the `shared` property is editable.
attr_accessor :shared_metadata
+ # Reserved for DocuSign.
attr_accessor :smart_contract_information
#
attr_accessor :source
# Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
attr_accessor :status
+ # Metadata that indicates whether the `status` property is editable.
attr_accessor :status_metadata
#
attr_accessor :tab_group_labels
+ # Metadata that indicates whether the `tabGroupLabels` property is editable.
attr_accessor :tab_group_labels_metadata
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
attr_accessor :tab_id
+ # Metadata that indicates whether the `tabId` property is editable.
attr_accessor :tab_id_metadata
+ # Metadata that indicates whether the `tabLabel` property is editable.
attr_accessor :tab_label_metadata
#
attr_accessor :tab_order
+ # Metadata that indicates whether the `tabOrder` property is editable.
attr_accessor :tab_order_metadata
#
attr_accessor :tab_type
+ # Metadata that indicates whether the `tabType` property is editable.
attr_accessor :tab_type_metadata
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
attr_accessor :template_locked
+ # Metadata that indicates whether the `templateLocked` property is editable.
attr_accessor :template_locked_metadata
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
attr_accessor :template_required
+ # Metadata that indicates whether the `templateRequired` property is editable.
attr_accessor :template_required_metadata
#
attr_accessor :tooltip
+ # Metadata that indicates whether the `toolTip` property is editable.
attr_accessor :tool_tip_metadata
#
attr_accessor :use_background_as_canvas
# Width of the tab in pixels.
attr_accessor :width
+ # Metadata that indicates whether the `width` property is editable.
attr_accessor :width_metadata
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
attr_accessor :x_position
+ # Metadata that indicates whether the `xPosition` property is editable.
attr_accessor :x_position_metadata
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
attr_accessor :y_position
+ # Metadata that indicates whether the `yPosition` property is editable.
attr_accessor :y_position_metadata
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{