docusign_esign 2.11.0 → 3.0.0.rc1

data/lib/docusign_esign/models/tab_metadata.rb

@@ -3,7 +3,7 @@
 
 #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
 
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class TabMetadata
     # An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
     attr_accessor :anchor
@@ -40,9 +41,6 @@ module DocuSign_eSign
     # When set to **true**, the information in the tab is bold.
     attr_accessor :bold
 
-    # 
-    attr_accessor :collaborative
-
     # When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.  When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.  This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
     attr_accessor :conceal_value_on_document
 
@@ -114,15 +112,9 @@ module DocuSign_eSign
     # 
     attr_accessor :payment_item_name
 
-    # When set to **true** and shared is true, information must be entered in this field to complete the envelope. 
-    attr_accessor :require_all
-
     # When set to **true**, the signer is required to fill out this tab
     attr_accessor :required
 
-    # Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
-    attr_accessor :require_initial_on_shared_change
-
     # 
     attr_accessor :scale_value
 
@@ -155,6 +147,7 @@ module DocuSign_eSign
     # Width of the tab in pixels.
     attr_accessor :width
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -167,7 +160,6 @@ module DocuSign_eSign
         :'anchor_x_offset' => :'anchorXOffset',
         :'anchor_y_offset' => :'anchorYOffset',
         :'bold' => :'bold',
-        :'collaborative' => :'collaborative',
         :'conceal_value_on_document' => :'concealValueOnDocument',
         :'created_by_display_name' => :'createdByDisplayName',
         :'created_by_user_id' => :'createdByUserId',
@@ -192,9 +184,7 @@ module DocuSign_eSign
         :'payment_item_code' => :'paymentItemCode',
         :'payment_item_description' => :'paymentItemDescription',
         :'payment_item_name' => :'paymentItemName',
-        :'require_all' => :'requireAll',
         :'required' => :'required',
-        :'require_initial_on_shared_change' => :'requireInitialOnSharedChange',
         :'scale_value' => :'scaleValue',
         :'selected' => :'selected',
         :'shared' => :'shared',
@@ -221,7 +211,6 @@ module DocuSign_eSign
         :'anchor_x_offset' => :'String',
         :'anchor_y_offset' => :'String',
         :'bold' => :'String',
-        :'collaborative' => :'String',
         :'conceal_value_on_document' => :'String',
         :'created_by_display_name' => :'String',
         :'created_by_user_id' => :'String',
@@ -246,9 +235,7 @@ module DocuSign_eSign
         :'payment_item_code' => :'String',
         :'payment_item_description' => :'String',
         :'payment_item_name' => :'String',
-        :'require_all' => :'String',
         :'required' => :'String',
-        :'require_initial_on_shared_change' => :'String',
         :'scale_value' => :'String',
         :'selected' => :'String',
         :'shared' => :'String',
@@ -269,7 +256,7 @@ module DocuSign_eSign
       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?(:'anchor')
         self.anchor = attributes[:'anchor']
@@ -307,10 +294,6 @@ module DocuSign_eSign
         self.bold = attributes[:'bold']
       end
 
-      if attributes.has_key?(:'collaborative')
-        self.collaborative = attributes[:'collaborative']
-      end
-
       if attributes.has_key?(:'concealValueOnDocument')
         self.conceal_value_on_document = attributes[:'concealValueOnDocument']
       end
@@ -409,18 +392,10 @@ module DocuSign_eSign
         self.payment_item_name = attributes[:'paymentItemName']
       end
 
-      if attributes.has_key?(:'requireAll')
-        self.require_all = attributes[:'requireAll']
-      end
-
       if attributes.has_key?(:'required')
         self.required = attributes[:'required']
       end
 
-      if attributes.has_key?(:'requireInitialOnSharedChange')
-        self.require_initial_on_shared_change = attributes[:'requireInitialOnSharedChange']
-      end
-
       if attributes.has_key?(:'scaleValue')
         self.scale_value = attributes[:'scaleValue']
       end
@@ -464,19 +439,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'width')
         self.width = attributes[:'width']
       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.
@@ -493,7 +469,6 @@ module DocuSign_eSign
           anchor_x_offset == o.anchor_x_offset &&
           anchor_y_offset == o.anchor_y_offset &&
           bold == o.bold &&
-          collaborative == o.collaborative &&
           conceal_value_on_document == o.conceal_value_on_document &&
           created_by_display_name == o.created_by_display_name &&
           created_by_user_id == o.created_by_user_id &&
@@ -518,9 +493,7 @@ module DocuSign_eSign
           payment_item_code == o.payment_item_code &&
           payment_item_description == o.payment_item_description &&
           payment_item_name == o.payment_item_name &&
-          require_all == o.require_all &&
           required == o.required &&
-          require_initial_on_shared_change == o.require_initial_on_shared_change &&
           scale_value == o.scale_value &&
           selected == o.selected &&
           shared == o.shared &&
@@ -543,7 +516,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, collaborative, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locked, maximum_length, merge_field, name, payment_item_code, payment_item_description, payment_item_name, require_all, required, require_initial_on_shared_change, scale_value, selected, shared, stamp_type, stamp_type_metadata, tab_label, type, underline, validation_message, validation_pattern, width].hash
+      [anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locked, maximum_length, merge_field, name, payment_item_code, payment_item_description, payment_item_name, required, scale_value, selected, shared, stamp_type, stamp_type_metadata, tab_label, type, underline, validation_message, validation_pattern, width].hash
     end
 
     # Builds the object from hash
@@ -553,10 +526,10 @@ module DocuSign_eSign
       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]]))
@@ -638,7 +611,7 @@ module DocuSign_eSign
     # @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) }
@@ -651,4 +624,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/tab_metadata_list.rb

@@ -3,7 +3,7 @@
 
 #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
 
@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class TabMetadataList
     # 
     attr_accessor :tabs
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -36,26 +38,27 @@ module DocuSign_eSign
       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?(:'tabs')
         if (value = attributes[:'tabs']).is_a?(Array)
           self.tabs = value
         end
       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.
@@ -85,10 +88,10 @@ module DocuSign_eSign
       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]]))
@@ -170,7 +173,7 @@ module DocuSign_eSign
     # @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) }
@@ -183,4 +186,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/tabs.rb

@@ -3,7 +3,7 @@
 
 #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
 
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class Tabs
     # Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history.
     attr_accessor :approve_tabs
@@ -19,6 +20,9 @@ module DocuSign_eSign
     # Specifies a tag on the document in a location where the recipient can select an option.
     attr_accessor :checkbox_tabs
 
+    # 
+    attr_accessor :comment_thread_tabs
+
     # Specifies a tag on the document where you want the recipient's company name to appear.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
     attr_accessor :company_tabs
 
@@ -67,6 +71,9 @@ module DocuSign_eSign
     # Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. 
     attr_accessor :number_tabs
 
+    # 
+    attr_accessor :poly_line_overlay_tabs
+
     # Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.
     attr_accessor :radio_group_tabs
 
@@ -82,6 +89,9 @@ module DocuSign_eSign
     # Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
     attr_accessor :ssn_tabs
 
+    # 
+    attr_accessor :tab_groups
+
     # Specifies a that that is an adaptable field that allows the recipient to enter different text information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
     attr_accessor :text_tabs
 
@@ -94,11 +104,13 @@ module DocuSign_eSign
     # Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
     attr_accessor :zip_tabs
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'approve_tabs' => :'approveTabs',
         :'checkbox_tabs' => :'checkboxTabs',
+        :'comment_thread_tabs' => :'commentThreadTabs',
         :'company_tabs' => :'companyTabs',
         :'date_signed_tabs' => :'dateSignedTabs',
         :'date_tabs' => :'dateTabs',
@@ -115,11 +127,13 @@ module DocuSign_eSign
         :'notarize_tabs' => :'notarizeTabs',
         :'note_tabs' => :'noteTabs',
         :'number_tabs' => :'numberTabs',
+        :'poly_line_overlay_tabs' => :'polyLineOverlayTabs',
         :'radio_group_tabs' => :'radioGroupTabs',
         :'signer_attachment_tabs' => :'signerAttachmentTabs',
         :'sign_here_tabs' => :'signHereTabs',
         :'smart_section_tabs' => :'smartSectionTabs',
         :'ssn_tabs' => :'ssnTabs',
+        :'tab_groups' => :'tabGroups',
         :'text_tabs' => :'textTabs',
         :'title_tabs' => :'titleTabs',
         :'view_tabs' => :'viewTabs',
@@ -132,6 +146,7 @@ module DocuSign_eSign
       {
         :'approve_tabs' => :'Array<Approve>',
         :'checkbox_tabs' => :'Array<Checkbox>',
+        :'comment_thread_tabs' => :'Array<CommentThread>',
         :'company_tabs' => :'Array<Company>',
         :'date_signed_tabs' => :'Array<DateSigned>',
         :'date_tabs' => :'Array<DocuSign_eSign::Date>',
@@ -144,15 +159,17 @@ module DocuSign_eSign
         :'full_name_tabs' => :'Array<FullName>',
         :'initial_here_tabs' => :'Array<InitialHere>',
         :'last_name_tabs' => :'Array<LastName>',
-        :'list_tabs' => :'Array<List>',
+        :'list_tabs' => :'Array<Array>',
         :'notarize_tabs' => :'Array<Notarize>',
         :'note_tabs' => :'Array<Note>',
         :'number_tabs' => :'Array<Number>',
+        :'poly_line_overlay_tabs' => :'Array<PolyLineOverlay>',
         :'radio_group_tabs' => :'Array<RadioGroup>',
         :'signer_attachment_tabs' => :'Array<SignerAttachment>',
         :'sign_here_tabs' => :'Array<SignHere>',
         :'smart_section_tabs' => :'Array<SmartSection>',
         :'ssn_tabs' => :'Array<Ssn>',
+        :'tab_groups' => :'Array<TabGroup>',
         :'text_tabs' => :'Array<Text>',
         :'title_tabs' => :'Array<Title>',
         :'view_tabs' => :'Array<View>',
@@ -166,7 +183,7 @@ module DocuSign_eSign
       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?(:'approveTabs')
         if (value = attributes[:'approveTabs']).is_a?(Array)
@@ -180,6 +197,12 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'commentThreadTabs')
+        if (value = attributes[:'commentThreadTabs']).is_a?(Array)
+          self.comment_thread_tabs = value
+        end
+      end
+
       if attributes.has_key?(:'companyTabs')
         if (value = attributes[:'companyTabs']).is_a?(Array)
           self.company_tabs = value
@@ -276,6 +299,12 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'polyLineOverlayTabs')
+        if (value = attributes[:'polyLineOverlayTabs']).is_a?(Array)
+          self.poly_line_overlay_tabs = value
+        end
+      end
+
       if attributes.has_key?(:'radioGroupTabs')
         if (value = attributes[:'radioGroupTabs']).is_a?(Array)
           self.radio_group_tabs = value
@@ -306,6 +335,12 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'tabGroups')
+        if (value = attributes[:'tabGroups']).is_a?(Array)
+          self.tab_groups = value
+        end
+      end
+
       if attributes.has_key?(:'textTabs')
         if (value = attributes[:'textTabs']).is_a?(Array)
           self.text_tabs = value
@@ -329,19 +364,20 @@ module DocuSign_eSign
           self.zip_tabs = value
         end
       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.
@@ -351,6 +387,7 @@ module DocuSign_eSign
       self.class == o.class &&
           approve_tabs == o.approve_tabs &&
           checkbox_tabs == o.checkbox_tabs &&
+          comment_thread_tabs == o.comment_thread_tabs &&
           company_tabs == o.company_tabs &&
           date_signed_tabs == o.date_signed_tabs &&
           date_tabs == o.date_tabs &&
@@ -367,11 +404,13 @@ module DocuSign_eSign
           notarize_tabs == o.notarize_tabs &&
           note_tabs == o.note_tabs &&
           number_tabs == o.number_tabs &&
+          poly_line_overlay_tabs == o.poly_line_overlay_tabs &&
           radio_group_tabs == o.radio_group_tabs &&
           signer_attachment_tabs == o.signer_attachment_tabs &&
           sign_here_tabs == o.sign_here_tabs &&
           smart_section_tabs == o.smart_section_tabs &&
           ssn_tabs == o.ssn_tabs &&
+          tab_groups == o.tab_groups &&
           text_tabs == o.text_tabs &&
           title_tabs == o.title_tabs &&
           view_tabs == o.view_tabs &&
@@ -387,7 +426,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [approve_tabs, checkbox_tabs, company_tabs, date_signed_tabs, date_tabs, decline_tabs, email_address_tabs, email_tabs, envelope_id_tabs, first_name_tabs, formula_tabs, full_name_tabs, initial_here_tabs, last_name_tabs, list_tabs, notarize_tabs, note_tabs, number_tabs, radio_group_tabs, signer_attachment_tabs, sign_here_tabs, smart_section_tabs, ssn_tabs, text_tabs, title_tabs, view_tabs, zip_tabs].hash
+      [approve_tabs, checkbox_tabs, comment_thread_tabs, company_tabs, date_signed_tabs, date_tabs, decline_tabs, email_address_tabs, email_tabs, envelope_id_tabs, first_name_tabs, formula_tabs, full_name_tabs, initial_here_tabs, last_name_tabs, list_tabs, notarize_tabs, note_tabs, number_tabs, poly_line_overlay_tabs, radio_group_tabs, signer_attachment_tabs, sign_here_tabs, smart_section_tabs, ssn_tabs, tab_groups, text_tabs, title_tabs, view_tabs, zip_tabs].hash
     end
 
     # Builds the object from hash
@@ -397,10 +436,10 @@ module DocuSign_eSign
       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]]))
@@ -482,7 +521,7 @@ module DocuSign_eSign
     # @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) }
@@ -495,4 +534,5 @@ module DocuSign_eSign
     end
 
   end
+
 end