docusign_esign 3.21.0 → 3.23.0

data/lib/docusign_esign/models/tabs.rb

@@ -38,9 +38,6 @@ module DocuSign_eSign
     # 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
 
-    # 
-    attr_accessor :currency_tabs
-
     # Specifies a tab on the document where the date the document was signed will automatically appear.
     attr_accessor :date_signed_tabs
 
@@ -145,7 +142,6 @@ module DocuSign_eSign
         :'commission_number_tabs' => :'commissionNumberTabs',
         :'commission_state_tabs' => :'commissionStateTabs',
         :'company_tabs' => :'companyTabs',
-        :'currency_tabs' => :'currencyTabs',
         :'date_signed_tabs' => :'dateSignedTabs',
         :'date_tabs' => :'dateTabs',
         :'decline_tabs' => :'declineTabs',
@@ -191,7 +187,6 @@ module DocuSign_eSign
         :'commission_number_tabs' => :'Array<CommissionNumber>',
         :'commission_state_tabs' => :'Array<CommissionState>',
         :'company_tabs' => :'Array<Company>',
-        :'currency_tabs' => :'Array<Currency>',
         :'date_signed_tabs' => :'Array<DateSigned>',
         :'date_tabs' => :'Array<DocuSign_eSign::Date>',
         :'decline_tabs' => :'Array<Decline>',
@@ -282,12 +277,6 @@ module DocuSign_eSign
         end
       end
 
-      if attributes.has_key?(:'currencyTabs')
-        if (value = attributes[:'currencyTabs']).is_a?(Array)
-          self.currency_tabs = value
-        end
-      end
-
       if attributes.has_key?(:'dateSignedTabs')
         if (value = attributes[:'dateSignedTabs']).is_a?(Array)
           self.date_signed_tabs = value
@@ -499,7 +488,6 @@ module DocuSign_eSign
           commission_number_tabs == o.commission_number_tabs &&
           commission_state_tabs == o.commission_state_tabs &&
           company_tabs == o.company_tabs &&
-          currency_tabs == o.currency_tabs &&
           date_signed_tabs == o.date_signed_tabs &&
           date_tabs == o.date_tabs &&
           decline_tabs == o.decline_tabs &&
@@ -542,7 +530,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [approve_tabs, checkbox_tabs, comment_thread_tabs, commission_county_tabs, commission_expiration_tabs, commission_number_tabs, commission_state_tabs, company_tabs, currency_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_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, notary_seal_tabs, note_tabs, number_tabs, numerical_tabs, phone_number_tabs, poly_line_overlay_tabs, prefill_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
+      [approve_tabs, checkbox_tabs, comment_thread_tabs, commission_county_tabs, commission_expiration_tabs, commission_number_tabs, commission_state_tabs, company_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_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, notary_seal_tabs, note_tabs, number_tabs, numerical_tabs, phone_number_tabs, poly_line_overlay_tabs, prefill_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

data/lib/docusign_esign/models/template_recipients.rb

@@ -28,7 +28,7 @@ module DocuSign_eSign
     # 
     attr_accessor :editors
 
-    # This object describes errors that occur. It is only valid for responses and ignored in requests.
+    # Array or errors.
     attr_accessor :error_details
 
     # Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.

data/lib/docusign_esign/models/template_role.rb

@@ -32,7 +32,7 @@ module DocuSign_eSign
     # Specifies the email associated with a role name.
     attr_accessor :email
 
-    # An optional complex type that sets a specific email subject and body for this recipient's notification email.   **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. 
+    # A complex type that contains information sets the language of the recipient's email information.   **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. 
     attr_accessor :email_notification
 
     # Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.   If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.  It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.  If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.   *Example*:   `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` 

data/lib/docusign_esign/models/template_shared_item.rb

@@ -14,7 +14,7 @@ require 'date'
 module DocuSign_eSign
   # Information about shared templates.
   class TemplateSharedItem
-    # This object describes errors that occur. It is only valid for responses and ignored in requests.
+    # Array or errors.
     attr_accessor :error_details
 
     # Information about the user who owns the template.

data/lib/docusign_esign/models/template_summary.rb

@@ -23,7 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :document_name
 
-    # This object describes errors that occur. It is only valid for responses and ignored in requests.
+    # Array or errors.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/template_tabs.rb

@@ -37,9 +37,6 @@ module DocuSign_eSign
     # 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
 
-    # 
-    attr_accessor :currency_tabs
-
     # Specifies a tab on the document where the date the document was signed will automatically appear.
     attr_accessor :date_signed_tabs
 
@@ -144,7 +141,6 @@ module DocuSign_eSign
         :'commission_number_tabs' => :'commissionNumberTabs',
         :'commission_state_tabs' => :'commissionStateTabs',
         :'company_tabs' => :'companyTabs',
-        :'currency_tabs' => :'currencyTabs',
         :'date_signed_tabs' => :'dateSignedTabs',
         :'date_tabs' => :'dateTabs',
         :'decline_tabs' => :'declineTabs',
@@ -190,7 +186,6 @@ module DocuSign_eSign
         :'commission_number_tabs' => :'Array<CommissionNumber>',
         :'commission_state_tabs' => :'Array<CommissionState>',
         :'company_tabs' => :'Array<Company>',
-        :'currency_tabs' => :'Array<Currency>',
         :'date_signed_tabs' => :'Array<DateSigned>',
         :'date_tabs' => :'Array<DocuSign_eSign::Date>',
         :'decline_tabs' => :'Array<Decline>',
@@ -281,12 +276,6 @@ module DocuSign_eSign
         end
       end
 
-      if attributes.has_key?(:'currencyTabs')
-        if (value = attributes[:'currencyTabs']).is_a?(Array)
-          self.currency_tabs = value
-        end
-      end
-
       if attributes.has_key?(:'dateSignedTabs')
         if (value = attributes[:'dateSignedTabs']).is_a?(Array)
           self.date_signed_tabs = value
@@ -498,7 +487,6 @@ module DocuSign_eSign
           commission_number_tabs == o.commission_number_tabs &&
           commission_state_tabs == o.commission_state_tabs &&
           company_tabs == o.company_tabs &&
-          currency_tabs == o.currency_tabs &&
           date_signed_tabs == o.date_signed_tabs &&
           date_tabs == o.date_tabs &&
           decline_tabs == o.decline_tabs &&
@@ -541,7 +529,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [approve_tabs, checkbox_tabs, comment_thread_tabs, commission_county_tabs, commission_expiration_tabs, commission_number_tabs, commission_state_tabs, company_tabs, currency_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_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, notary_seal_tabs, note_tabs, number_tabs, numerical_tabs, phone_number_tabs, poly_line_overlay_tabs, prefill_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
+      [approve_tabs, checkbox_tabs, comment_thread_tabs, commission_county_tabs, commission_expiration_tabs, commission_number_tabs, commission_state_tabs, company_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_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, notary_seal_tabs, note_tabs, number_tabs, numerical_tabs, phone_number_tabs, poly_line_overlay_tabs, prefill_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

data/lib/docusign_esign/models/template_update_summary.rb

@@ -19,7 +19,7 @@ module DocuSign_eSign
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id
 
-    # This object describes errors that occur. It is only valid for responses and ignored in requests.
+    # Array or errors.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/text.rb

@@ -83,6 +83,7 @@ module DocuSign_eSign
     # 
     attr_accessor :caption
 
+    # 
     attr_accessor :caption_metadata
 
     # 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.
@@ -121,7 +122,7 @@ module DocuSign_eSign
     # 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.
+    # Array or errors.
     attr_accessor :error_details
 
     # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica,   LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.

data/lib/docusign_esign/models/text_custom_field.rb

@@ -17,7 +17,7 @@ module DocuSign_eSign
     # If merge field's are being used, specifies the type of the merge field. The only  supported value is **salesforce**.
     attr_accessor :configuration_type
 
-    # This object describes errors that occur. It is only valid for responses and ignored in requests.
+    # Array or errors.
     attr_accessor :error_details
 
     # An ID used to specify a custom field.

data/lib/docusign_esign/models/title.rb

@@ -83,6 +83,7 @@ module DocuSign_eSign
     # 
     attr_accessor :caption
 
+    # 
     attr_accessor :caption_metadata
 
     # 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.
@@ -121,7 +122,7 @@ module DocuSign_eSign
     # 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.
+    # Array or errors.
     attr_accessor :error_details
 
     # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica,   LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.

data/lib/docusign_esign/models/user_account_management_granular_information.rb

@@ -59,6 +59,7 @@ module DocuSign_eSign
     # 
     attr_accessor :can_manage_joint_agreements
 
+    # 
     attr_accessor :can_manage_joint_agreements_metadata
 
     # 
@@ -82,6 +83,7 @@ module DocuSign_eSign
     # 
     attr_accessor :can_manage_stamps
 
+    # 
     attr_accessor :can_manage_stamps_metadata
 
     # 

data/lib/docusign_esign/models/user_authorization.rb

@@ -0,0 +1,274 @@
+=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.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class UserAuthorization
+    # 
+    attr_accessor :agent_user
+
+    # 
+    attr_accessor :authorization_id
+
+    # 
+    attr_accessor :created
+
+    # 
+    attr_accessor :created_by
+
+    # 
+    attr_accessor :end_date
+
+    # 
+    attr_accessor :modified
+
+    # 
+    attr_accessor :modified_by
+
+    # 
+    attr_accessor :permission
+
+    # 
+    attr_accessor :principal_user
+
+    # 
+    attr_accessor :start_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'agent_user' => :'agentUser',
+        :'authorization_id' => :'authorizationId',
+        :'created' => :'created',
+        :'created_by' => :'createdBy',
+        :'end_date' => :'endDate',
+        :'modified' => :'modified',
+        :'modified_by' => :'modifiedBy',
+        :'permission' => :'permission',
+        :'principal_user' => :'principalUser',
+        :'start_date' => :'startDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'agent_user' => :'AuthorizationUser',
+        :'authorization_id' => :'String',
+        :'created' => :'String',
+        :'created_by' => :'String',
+        :'end_date' => :'String',
+        :'modified' => :'String',
+        :'modified_by' => :'String',
+        :'permission' => :'String',
+        :'principal_user' => :'AuthorizationUser',
+        :'start_date' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @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 }
+
+      if attributes.has_key?(:'agentUser')
+        self.agent_user = attributes[:'agentUser']
+      end
+
+      if attributes.has_key?(:'authorizationId')
+        self.authorization_id = attributes[:'authorizationId']
+      end
+
+      if attributes.has_key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.has_key?(:'createdBy')
+        self.created_by = attributes[:'createdBy']
+      end
+
+      if attributes.has_key?(:'endDate')
+        self.end_date = attributes[:'endDate']
+      end
+
+      if attributes.has_key?(:'modified')
+        self.modified = attributes[:'modified']
+      end
+
+      if attributes.has_key?(:'modifiedBy')
+        self.modified_by = attributes[:'modifiedBy']
+      end
+
+      if attributes.has_key?(:'permission')
+        self.permission = attributes[:'permission']
+      end
+
+      if attributes.has_key?(:'principalUser')
+        self.principal_user = attributes[:'principalUser']
+      end
+
+      if attributes.has_key?(:'startDate')
+        self.start_date = attributes[:'startDate']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      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
+    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 &&
+          agent_user == o.agent_user &&
+          authorization_id == o.authorization_id &&
+          created == o.created &&
+          created_by == o.created_by &&
+          end_date == o.end_date &&
+          modified == o.modified &&
+          modified_by == o.modified_by &&
+          permission == o.permission &&
+          principal_user == o.principal_user &&
+          start_date == o.start_date
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [agent_user, authorization_id, created, created_by, end_date, modified, modified_by, permission, principal_user, start_date].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
+          # 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) })
+          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
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = DocuSign_eSign.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # 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) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end