dropbox-sign 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4a4bf5fa059cb4f6ad1d44989afda4fe6cda83bea9692a2e73d50e8f0f8dc6c
-  data.tar.gz: 6c6765e5adf2e5b4734ef7d5bed6d7fe329b20881b9b9df484b0e9594dae4bfd
+  metadata.gz: 0e64c9f5e87bb51e133c06c546b9eb4747739867caf0cd4e062d74a17e052762
+  data.tar.gz: f698e9b93152e1cbee38194acb69b64d64697a7d93fa9dc72b3cc45cf58ec2cd
 SHA512:
-  metadata.gz: 7bdad2bf4c2d5e4d9d72e53d64c785140fc0e7fc4addb2187ccacb9795b29b2b1d7d6508a0fe4df705bb491dea7ce9547195490ab71a87f3315993965248f63d
-  data.tar.gz: 26eaf172fb40a46bee4531e40fba88c35dce1a2326bab42efc5bc47b96a83ce24c98d71971ec47ee99a020410e04f25a0d0246b27408c3e162e32616625bd19a
+  metadata.gz: ef5f4840f660e312d30b0b6d6bc27c36341fc37ae675a63856a374bc3deb28f21ddc8fa79f72b9e41997d23ceefe73e1b0cd763070a95f7f9fc9e2c31ac5587d
+  data.tar.gz: 69e9db06937df1c18f78246c5e8a180da82ac20865a1c4658868e8d6dc50c8276f64d60b588402d88cd1d05876b256cfa1be1035ac6fbe6774faa415f516ca7a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dropbox-sign (1.7.0)
+    dropbox-sign (1.8.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -25,7 +25,7 @@ directory that corresponds to the file you want updated.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 3.0.0
-- Package version: 1.7.0
+- Package version: 1.8.0
 - Generator version: 7.8.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./dropbox-sign-1.7.0.gem
+gem install ./dropbox-sign-1.8.0.gem
 ```
 
-(for development, run `gem install --dev ./dropbox-sign-1.7.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dropbox-sign-1.8.0.gem` to install the development dependencies)
 
 
 Finally add this to the Gemfile:
 
-    gem 'dropbox-sign', '~> 1.7.0'
+    gem 'dropbox-sign', '~> 1.8.0'
 
 ### Install from Git
 

data/VERSION

@@ -1 +1 @@
-1.7.0
+1.8.0

data/docs/BulkSendJobGetResponseSignatureRequests.md

@@ -13,7 +13,7 @@
 | `original_title` | ```String``` |  Default Label for account.  |  |
 | `subject` | ```String``` |  The subject in the email that was initially sent to the signers.  |  |
 | `message` | ```String``` |  The custom message in the email that was initially sent to the signers.  |  |
-| `metadata` | ```Object``` |  The metadata attached to the signature request.  |  |
+| `metadata` | ```Hash<String, Object>``` |  The metadata attached to the signature request.  |  |
 | `created_at` | ```Integer``` |  Time the signature request was created.  |  |
 | `expires_at` | ```Integer``` |  The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.  |  |
 | `is_complete` | ```Boolean``` |  Whether or not the SignatureRequest has been fully executed by all signers.  |  |

data/docs/FaxResponse.md

@@ -9,11 +9,12 @@
 | `fax_id`<sup>*_required_</sup> | ```String``` |  Fax ID  |  |
 | `title`<sup>*_required_</sup> | ```String``` |  Fax Title  |  |
 | `original_title`<sup>*_required_</sup> | ```String``` |  Fax Original Title  |  |
-| `subject`<sup>*_required_</sup> | ```String``` |  Fax Subject  |  |
-| `message`<sup>*_required_</sup> | ```String``` |  Fax Message  |  |
 | `metadata`<sup>*_required_</sup> | ```Hash<String, Object>``` |  Fax Metadata  |  |
 | `created_at`<sup>*_required_</sup> | ```Integer``` |  Fax Created At Timestamp  |  |
 | `sender`<sup>*_required_</sup> | ```String``` |  Fax Sender Email  |  |
-| `transmissions`<sup>*_required_</sup> | [```Array<FaxResponseTransmission>```](FaxResponseTransmission.md) |  Fax Transmissions List  |  |
 | `files_url`<sup>*_required_</sup> | ```String``` |  Fax Files URL  |  |
+| `transmissions`<sup>*_required_</sup> | [```Array<FaxResponseTransmission>```](FaxResponseTransmission.md) |  Fax Transmissions List  |  |
+| `subject` | ```String``` |  Fax Subject  |  |
+| `message` | ```String``` |  Fax Message  |  |
+| `final_copy_uri` | ```String``` |  The path where the completed document can be downloaded  |  |
 

data/docs/FaxResponseTransmission.md

@@ -7,7 +7,6 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `recipient`<sup>*_required_</sup> | ```String``` |  Fax Transmission Recipient  |  |
-| `sender`<sup>*_required_</sup> | ```String``` |  Fax Transmission Sender  |  |
 | `status_code`<sup>*_required_</sup> | ```String``` |  Fax Transmission Status Code  |  |
 | `sent_at` | ```Integer``` |  Fax Transmission Sent Timestamp  |  |
 

data/docs/SignatureRequestResponse.md

@@ -13,7 +13,7 @@ Contains information about a signature request.
 | `original_title` | ```String``` |  Default Label for account.  |  |
 | `subject` | ```String``` |  The subject in the email that was initially sent to the signers.  |  |
 | `message` | ```String``` |  The custom message in the email that was initially sent to the signers.  |  |
-| `metadata` | ```Object``` |  The metadata attached to the signature request.  |  |
+| `metadata` | ```Hash<String, Object>``` |  The metadata attached to the signature request.  |  |
 | `created_at` | ```Integer``` |  Time the signature request was created.  |  |
 | `expires_at` | ```Integer``` |  The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.  |  |
 | `is_complete` | ```Boolean``` |  Whether or not the SignatureRequest has been fully executed by all signers.  |  |

data/docs/SignatureRequestResponseDataValueInitials.md

@@ -8,4 +8,5 @@
 | ---- | ---- | ----------- | ----- |
 | `type` | ```String``` |  An input field for initials  |  [default to 'initials'] |
 | `value` | ```String``` |  The value of the form field.  |  |
+| `is_signed` | ```Boolean``` |  This field contains the boolean true if the field is signed.  |  |
 

data/docs/SignatureRequestResponseDataValueSignature.md

@@ -8,4 +8,5 @@
 | ---- | ---- | ----------- | ----- |
 | `type` | ```String``` |  A signature input field  |  [default to 'signature'] |
 | `value` | ```String``` |  The value of the form field.  |  |
+| `is_signed` | ```Boolean``` |  This field contains the boolean true if the field is signed.  |  |
 

data/docs/TemplateResponse.md

@@ -14,7 +14,7 @@ Contains information about the templates you and your team have created.
 | `is_creator` | ```Boolean``` |  `true` if you are the owner of this template, `false` if it's been shared with you by a team member.  |  |
 | `can_edit` | ```Boolean``` |  Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).  |  |
 | `is_locked` | ```Boolean``` |  Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.  |  |
-| `metadata` | ```Object``` |  The metadata attached to the template.  |  |
+| `metadata` | ```Hash<String, Object>``` |  The metadata attached to the template.  |  |
 | `signer_roles` | [```Array<TemplateResponseSignerRole>```](TemplateResponseSignerRole.md) |  An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.  |  |
 | `cc_roles` | [```Array<TemplateResponseCCRole>```](TemplateResponseCCRole.md) |  An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.  |  |
 | `documents` | [```Array<TemplateResponseDocument>```](TemplateResponseDocument.md) |  An array describing each document associated with this Template. Includes form field data for each document.  |  |

data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb

@@ -19,7 +19,7 @@ end
 module Dropbox::Sign
   class BulkSendJobGetResponseSignatureRequests
     # Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
-    # @return [Boolean, nil]
+    # @return [Boolean]
     attr_accessor :test_mode
 
     # The id of the SignatureRequest.
@@ -27,7 +27,7 @@ module Dropbox::Sign
     attr_accessor :signature_request_id
 
     # The email address of the initiator of the SignatureRequest.
-    # @return [String]
+    # @return [String, nil]
     attr_accessor :requester_email_address
 
     # The title the specified Account uses for the SignatureRequest.
@@ -47,7 +47,7 @@ module Dropbox::Sign
     attr_accessor :message
 
     # The metadata attached to the signature request.
-    # @return [Object]
+    # @return [Hash<String, Object>]
     attr_accessor :metadata
 
     # Time the signature request was created.
@@ -55,7 +55,7 @@ module Dropbox::Sign
     attr_accessor :created_at
 
     # The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
-    # @return [Integer]
+    # @return [Integer, nil]
     attr_accessor :expires_at
 
     # Whether or not the SignatureRequest has been fully executed by all signers.
@@ -164,7 +164,7 @@ module Dropbox::Sign
         :'original_title' => :'String',
         :'subject' => :'String',
         :'message' => :'String',
-        :'metadata' => :'Object',
+        :'metadata' => :'Hash<String, Object>',
         :'created_at' => :'Integer',
         :'expires_at' => :'Integer',
         :'is_complete' => :'Boolean',
@@ -188,9 +188,10 @@ module Dropbox::Sign
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'test_mode',
+        :'requester_email_address',
         :'subject',
         :'message',
+        :'expires_at',
         :'signing_url',
         :'signing_redirect_url',
         :'final_copy_uri',
@@ -272,7 +273,9 @@ module Dropbox::Sign
       end
 
       if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
 
       if attributes.key?(:'created_at')

data/lib/dropbox-sign/models/fax_response.rb

@@ -30,14 +30,6 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :original_title
 
-    # Fax Subject
-    # @return [String]
-    attr_accessor :subject
-
-    # Fax Message
-    # @return [String]
-    attr_accessor :message
-
     # Fax Metadata
     # @return [Hash<String, Object>]
     attr_accessor :metadata
@@ -50,13 +42,25 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :sender
 
+    # Fax Files URL
+    # @return [String]
+    attr_accessor :files_url
+
     # Fax Transmissions List
     # @return [Array<FaxResponseTransmission>]
     attr_accessor :transmissions
 
-    # Fax Files URL
-    # @return [String]
-    attr_accessor :files_url
+    # Fax Subject
+    # @return [String, nil]
+    attr_accessor :subject
+
+    # Fax Message
+    # @return [String, nil]
+    attr_accessor :message
+
+    # The path where the completed document can be downloaded
+    # @return [String, nil]
+    attr_accessor :final_copy_uri
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -64,13 +68,14 @@ module Dropbox::Sign
         :'fax_id' => :'fax_id',
         :'title' => :'title',
         :'original_title' => :'original_title',
-        :'subject' => :'subject',
-        :'message' => :'message',
         :'metadata' => :'metadata',
         :'created_at' => :'created_at',
         :'sender' => :'sender',
+        :'files_url' => :'files_url',
         :'transmissions' => :'transmissions',
-        :'files_url' => :'files_url'
+        :'subject' => :'subject',
+        :'message' => :'message',
+        :'final_copy_uri' => :'final_copy_uri'
       }
     end
 
@@ -85,19 +90,23 @@ module Dropbox::Sign
         :'fax_id' => :'String',
         :'title' => :'String',
         :'original_title' => :'String',
-        :'subject' => :'String',
-        :'message' => :'String',
         :'metadata' => :'Hash<String, Object>',
         :'created_at' => :'Integer',
         :'sender' => :'String',
+        :'files_url' => :'String',
         :'transmissions' => :'Array<FaxResponseTransmission>',
-        :'files_url' => :'String'
+        :'subject' => :'String',
+        :'message' => :'String',
+        :'final_copy_uri' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'subject',
+        :'message',
+        :'final_copy_uri'
       ])
     end
 
@@ -153,14 +162,6 @@ module Dropbox::Sign
         self.original_title = attributes[:'original_title']
       end
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
-      end
-
-      if attributes.key?(:'message')
-        self.message = attributes[:'message']
-      end
-
       if attributes.key?(:'metadata')
         if (value = attributes[:'metadata']).is_a?(Hash)
           self.metadata = value
@@ -175,14 +176,26 @@ module Dropbox::Sign
         self.sender = attributes[:'sender']
       end
 
+      if attributes.key?(:'files_url')
+        self.files_url = attributes[:'files_url']
+      end
+
       if attributes.key?(:'transmissions')
         if (value = attributes[:'transmissions']).is_a?(Array)
           self.transmissions = value
         end
       end
 
-      if attributes.key?(:'files_url')
-        self.files_url = attributes[:'files_url']
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'final_copy_uri')
+        self.final_copy_uri = attributes[:'final_copy_uri']
       end
     end
 
@@ -202,14 +215,6 @@ module Dropbox::Sign
         invalid_properties.push('invalid value for "original_title", original_title cannot be nil.')
       end
 
-      if @subject.nil?
-        invalid_properties.push('invalid value for "subject", subject cannot be nil.')
-      end
-
-      if @message.nil?
-        invalid_properties.push('invalid value for "message", message cannot be nil.')
-      end
-
       if @metadata.nil?
         invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
       end
@@ -222,14 +227,14 @@ module Dropbox::Sign
         invalid_properties.push('invalid value for "sender", sender cannot be nil.')
       end
 
-      if @transmissions.nil?
-        invalid_properties.push('invalid value for "transmissions", transmissions cannot be nil.')
-      end
-
       if @files_url.nil?
         invalid_properties.push('invalid value for "files_url", files_url cannot be nil.')
       end
 
+      if @transmissions.nil?
+        invalid_properties.push('invalid value for "transmissions", transmissions cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -239,13 +244,11 @@ module Dropbox::Sign
       return false if @fax_id.nil?
       return false if @title.nil?
       return false if @original_title.nil?
-      return false if @subject.nil?
-      return false if @message.nil?
       return false if @metadata.nil?
       return false if @created_at.nil?
       return false if @sender.nil?
-      return false if @transmissions.nil?
       return false if @files_url.nil?
+      return false if @transmissions.nil?
       true
     end
 
@@ -257,13 +260,14 @@ module Dropbox::Sign
           fax_id == o.fax_id &&
           title == o.title &&
           original_title == o.original_title &&
-          subject == o.subject &&
-          message == o.message &&
           metadata == o.metadata &&
           created_at == o.created_at &&
           sender == o.sender &&
+          files_url == o.files_url &&
           transmissions == o.transmissions &&
-          files_url == o.files_url
+          subject == o.subject &&
+          message == o.message &&
+          final_copy_uri == o.final_copy_uri
     end
 
     # @see the `==` method
@@ -275,7 +279,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [fax_id, title, original_title, subject, message, metadata, created_at, sender, transmissions, files_url].hash
+      [fax_id, title, original_title, metadata, created_at, sender, files_url, transmissions, subject, message, final_copy_uri].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/fax_response_transmission.rb

@@ -22,10 +22,6 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :recipient
 
-    # Fax Transmission Sender
-    # @return [String]
-    attr_accessor :sender
-
     # Fax Transmission Status Code
     # @return [String]
     attr_accessor :status_code
@@ -60,7 +56,6 @@ module Dropbox::Sign
     def self.attribute_map
       {
         :'recipient' => :'recipient',
-        :'sender' => :'sender',
         :'status_code' => :'status_code',
         :'sent_at' => :'sent_at'
       }
@@ -75,7 +70,6 @@ module Dropbox::Sign
     def self.openapi_types
       {
         :'recipient' => :'String',
-        :'sender' => :'String',
         :'status_code' => :'String',
         :'sent_at' => :'Integer'
       }
@@ -131,10 +125,6 @@ module Dropbox::Sign
         self.recipient = attributes[:'recipient']
       end
 
-      if attributes.key?(:'sender')
-        self.sender = attributes[:'sender']
-      end
-
       if attributes.key?(:'status_code')
         self.status_code = attributes[:'status_code']
       end
@@ -152,10 +142,6 @@ module Dropbox::Sign
         invalid_properties.push('invalid value for "recipient", recipient cannot be nil.')
       end
 
-      if @sender.nil?
-        invalid_properties.push('invalid value for "sender", sender cannot be nil.')
-      end
-
       if @status_code.nil?
         invalid_properties.push('invalid value for "status_code", status_code cannot be nil.')
       end
@@ -167,7 +153,6 @@ module Dropbox::Sign
     # @return true if the model is valid
     def valid?
       return false if @recipient.nil?
-      return false if @sender.nil?
       return false if @status_code.nil?
       status_code_validator = EnumAttributeValidator.new('String', ["success", "transmitting", "error_could_not_fax", "error_unknown", "error_busy", "error_no_answer", "error_disconnected", "error_bad_destination"])
       return false unless status_code_validator.valid?(@status_code)
@@ -190,7 +175,6 @@ module Dropbox::Sign
       return true if self.equal?(o)
       self.class == o.class &&
           recipient == o.recipient &&
-          sender == o.sender &&
           status_code == o.status_code &&
           sent_at == o.sent_at
     end
@@ -204,7 +188,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [recipient, sender, status_code, sent_at].hash
+      [recipient, status_code, sent_at].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/signature_request_response.rb

@@ -20,7 +20,7 @@ module Dropbox::Sign
   # Contains information about a signature request.
   class SignatureRequestResponse
     # Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
-    # @return [Boolean, nil]
+    # @return [Boolean]
     attr_accessor :test_mode
 
     # The id of the SignatureRequest.
@@ -28,7 +28,7 @@ module Dropbox::Sign
     attr_accessor :signature_request_id
 
     # The email address of the initiator of the SignatureRequest.
-    # @return [String]
+    # @return [String, nil]
     attr_accessor :requester_email_address
 
     # The title the specified Account uses for the SignatureRequest.
@@ -48,7 +48,7 @@ module Dropbox::Sign
     attr_accessor :message
 
     # The metadata attached to the signature request.
-    # @return [Object]
+    # @return [Hash<String, Object>]
     attr_accessor :metadata
 
     # Time the signature request was created.
@@ -56,7 +56,7 @@ module Dropbox::Sign
     attr_accessor :created_at
 
     # The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
-    # @return [Integer]
+    # @return [Integer, nil]
     attr_accessor :expires_at
 
     # Whether or not the SignatureRequest has been fully executed by all signers.
@@ -165,7 +165,7 @@ module Dropbox::Sign
         :'original_title' => :'String',
         :'subject' => :'String',
         :'message' => :'String',
-        :'metadata' => :'Object',
+        :'metadata' => :'Hash<String, Object>',
         :'created_at' => :'Integer',
         :'expires_at' => :'Integer',
         :'is_complete' => :'Boolean',
@@ -189,9 +189,10 @@ module Dropbox::Sign
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'test_mode',
+        :'requester_email_address',
         :'subject',
         :'message',
+        :'expires_at',
         :'signing_url',
         :'signing_redirect_url',
         :'final_copy_uri',
@@ -274,7 +275,9 @@ module Dropbox::Sign
       end
 
       if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
 
       if attributes.key?(:'created_at')

data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb

@@ -36,7 +36,7 @@ module Dropbox::Sign
     attr_accessor :api_id
 
     # The name of the Role that is able to edit this field.
-    # @return [String]
+    # @return [String, nil]
     attr_accessor :editor
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -69,6 +69,7 @@ module Dropbox::Sign
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'editor'
       ])
     end
 

data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb

@@ -26,11 +26,16 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :value
 
+    # This field contains the boolean true if the field is signed.
+    # @return [Boolean, nil]
+    attr_accessor :is_signed
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
-        :'value' => :'value'
+        :'value' => :'value',
+        :'is_signed' => :'is_signed'
       }
     end
 
@@ -43,13 +48,15 @@ module Dropbox::Sign
     def self.openapi_types
       {
         :'type' => :'String',
-        :'value' => :'String'
+        :'value' => :'String',
+        :'is_signed' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'is_signed'
       ])
     end
 
@@ -105,6 +112,10 @@ module Dropbox::Sign
       if attributes.key?(:'value')
         self.value = attributes[:'value']
       end
+
+      if attributes.key?(:'is_signed')
+        self.is_signed = attributes[:'is_signed']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,7 +137,8 @@ module Dropbox::Sign
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          value == o.value && super(o)
+          value == o.value &&
+          is_signed == o.is_signed && super(o)
     end
 
     # @see the `==` method
@@ -138,7 +150,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, value].hash
+      [type, value, is_signed].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb

@@ -26,11 +26,16 @@ module Dropbox::Sign
     # @return [String]
     attr_accessor :value
 
+    # This field contains the boolean true if the field is signed.
+    # @return [Boolean, nil]
+    attr_accessor :is_signed
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
-        :'value' => :'value'
+        :'value' => :'value',
+        :'is_signed' => :'is_signed'
       }
     end
 
@@ -43,13 +48,15 @@ module Dropbox::Sign
     def self.openapi_types
       {
         :'type' => :'String',
-        :'value' => :'String'
+        :'value' => :'String',
+        :'is_signed' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'is_signed'
       ])
     end
 
@@ -105,6 +112,10 @@ module Dropbox::Sign
       if attributes.key?(:'value')
         self.value = attributes[:'value']
       end
+
+      if attributes.key?(:'is_signed')
+        self.is_signed = attributes[:'is_signed']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,7 +137,8 @@ module Dropbox::Sign
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          value == o.value && super(o)
+          value == o.value &&
+          is_signed == o.is_signed && super(o)
     end
 
     # @see the `==` method
@@ -138,7 +150,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, value].hash
+      [type, value, is_signed].hash
     end
 
     # Builds the object from hash

data/lib/dropbox-sign/models/template_response.rb

@@ -52,7 +52,7 @@ module Dropbox::Sign
     attr_accessor :is_locked
 
     # The metadata attached to the template.
-    # @return [Object]
+    # @return [Hash<String, Object>]
     attr_accessor :metadata
 
     # An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
@@ -121,7 +121,7 @@ module Dropbox::Sign
         :'is_creator' => :'Boolean',
         :'can_edit' => :'Boolean',
         :'is_locked' => :'Boolean',
-        :'metadata' => :'Object',
+        :'metadata' => :'Hash<String, Object>',
         :'signer_roles' => :'Array<TemplateResponseSignerRole>',
         :'cc_roles' => :'Array<TemplateResponseCCRole>',
         :'documents' => :'Array<TemplateResponseDocument>',
@@ -214,7 +214,9 @@ module Dropbox::Sign
       end
 
       if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
 
       if attributes.key?(:'signer_roles')

data/lib/dropbox-sign/version.rb

@@ -14,5 +14,5 @@ module Dropbox
 end
 
 module Dropbox::Sign
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
 end

data/openapi-config.yaml

@@ -9,7 +9,7 @@ additionalProperties:
   gemName: dropbox-sign
   gemRequiredRubyVersion: '>= 2.7'
   moduleName: "Dropbox::Sign"
-  gemVersion: 1.7.0
+  gemVersion: 1.8.0
   sortModelPropertiesByRequiredFlag: true
   legacyDiscriminatorBehavior: true
   gitUserId: hellosign

data/openapi-sdk.yaml

@@ -11173,6 +11173,10 @@ components:
             bulk_send_job_id:
               description: 'The id of the BulkSendJob.'
               type: string
+            metadata:
+              description: 'The metadata attached to the signature request.'
+              type: object
+              additionalProperties: {}
       x-internal-class: true
     EmbeddedEditUrlResponseEmbedded:
       description: 'An embedded template object.'
@@ -11217,13 +11221,11 @@ components:
         - fax_id
         - title
         - original_title
-        - subject
-        - message
         - metadata
         - created_at
         - sender
-        - transmissions
         - files_url
+        - transmissions
       properties:
         fax_id:
           description: 'Fax ID'
@@ -11237,9 +11239,11 @@ components:
         subject:
           description: 'Fax Subject'
           type: string
+          nullable: true
         message:
           description: 'Fax Message'
           type: string
+          nullable: true
         metadata:
           description: 'Fax Metadata'
           type: object
@@ -11250,14 +11254,18 @@ components:
         sender:
           description: 'Fax Sender Email'
           type: string
+        files_url:
+          description: 'Fax Files URL'
+          type: string
+        final_copy_uri:
+          description: 'The path where the completed document can be downloaded'
+          type: string
+          nullable: true
         transmissions:
           description: 'Fax Transmissions List'
           type: array
           items:
             $ref: '#/components/schemas/FaxResponseTransmission'
-        files_url:
-          description: 'Fax Files URL'
-          type: string
       type: object
       x-internal-class: true
     FaxLineResponseFaxLine:
@@ -11280,15 +11288,11 @@ components:
     FaxResponseTransmission:
       required:
         - recipient
-        - sender
         - status_code
       properties:
         recipient:
           description: 'Fax Transmission Recipient'
           type: string
-        sender:
-          description: 'Fax Transmission Sender'
-          type: string
         status_code:
           description: 'Fax Transmission Status Code'
           type: string
@@ -11352,13 +11356,13 @@ components:
           description: 'Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.'
           type: boolean
           default: false
-          nullable: true
         signature_request_id:
           description: 'The id of the SignatureRequest.'
           type: string
         requester_email_address:
           description: 'The email address of the initiator of the SignatureRequest.'
           type: string
+          nullable: true
         title:
           description: 'The title the specified Account uses for the SignatureRequest.'
           type: string
@@ -11376,12 +11380,14 @@ components:
         metadata:
           description: 'The metadata attached to the signature request.'
           type: object
+          additionalProperties: {}
         created_at:
           description: 'Time the signature request was created.'
           type: integer
         expires_at:
           description: 'The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.'
           type: integer
+          nullable: true
         is_complete:
           description: 'Whether or not the SignatureRequest has been fully executed by all signers.'
           type: boolean
@@ -11509,6 +11515,7 @@ components:
         editor:
           description: 'The name of the Role that is able to edit this field.'
           type: string
+          nullable: true
       type: object
       discriminator:
         propertyName: type
@@ -11519,13 +11526,12 @@ components:
       x-base-class: true
     SignatureRequestResponseCustomFieldCheckbox:
       description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
+      required:
+        - type
       allOf:
         -
           $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
         -
-          required:
-            - name
-            - type
           properties:
             type:
               description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
@@ -11537,13 +11543,12 @@ components:
           type: object
     SignatureRequestResponseCustomFieldText:
       description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
+      required:
+        - type
       allOf:
         -
           $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
         -
-          required:
-            - name
-            - type
           properties:
             type:
               description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
@@ -11671,6 +11676,10 @@ components:
             value:
               description: 'The value of the form field.'
               type: string
+            is_signed:
+              description: 'This field contains the boolean true if the field is signed.'
+              type: boolean
+              nullable: true
           type: object
     SignatureRequestResponseDataValueRadio:
       allOf:
@@ -11699,6 +11708,10 @@ components:
             value:
               description: 'The value of the form field.'
               type: string
+            is_signed:
+              description: 'This field contains the boolean true if the field is signed.'
+              type: boolean
+              nullable: true
           type: object
     SignatureRequestResponseDataValueText:
       allOf:
@@ -11936,6 +11949,7 @@ components:
         metadata:
           description: 'The metadata attached to the template.'
           type: object
+          additionalProperties: {}
         signer_roles:
           description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.'
           type: array

data/test_fixtures/BulkSendJobGetResponse.json

@@ -24,6 +24,15 @@
         "custom_fields": [],
         "created_at": 0,
         "expires_at": 0,
+        "metadata": {
+          "metadata_name_1": "metadata_value_1",
+          "metadata_name_2": {
+            "metadata_name_2_a": "metadata_value_2_a"
+          },
+          "metadata_name_3": "metadata_value_3",
+          "custom_id": 1234,
+          "custom_text": "NDA #9"
+        },
         "response_data": [
           {
             "api_id": "80c678_1",

data/test_fixtures/FaxGetResponse.json

@@ -6,7 +6,15 @@
       "original_title": "example original title",
       "subject": "example subject",
       "message": "example message",
-      "metadata": [],
+      "metadata": {
+        "metadata_name_1": "metadata_value_1",
+        "metadata_name_2": {
+          "metadata_name_2_a": "metadata_value_2_a"
+        },
+        "metadata_name_3": "metadata_value_3",
+        "custom_id": 1234,
+        "custom_text": "NDA #9"
+      },
       "created_at": 1726774555,
       "sender": "me@dropboxsign.com",
       "transmissions": [

data/test_fixtures/FaxListResponse.json

@@ -13,7 +13,15 @@
         "original_title": "example original title",
         "subject": "example subject",
         "message": "example message",
-        "metadata": [],
+        "metadata": {
+          "metadata_name_1": "metadata_value_1",
+          "metadata_name_2": {
+            "metadata_name_2_a": "metadata_value_2_a"
+          },
+          "metadata_name_3": "metadata_value_3",
+          "custom_id": 1234,
+          "custom_text": "NDA #9"
+        },
         "created_at": 1726774555,
         "sender": "me@dropboxsign.com",
         "transmissions": [

data/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json

@@ -18,7 +18,13 @@
     ],
     "message": "Glad we could come to an agreement.",
     "metadata": {
-      "field1": "value1"
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
+      "custom_id": 1234,
+      "custom_text": "NDA #9"
     },
     "signer_list": [
       {

data/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json

@@ -17,7 +17,13 @@
     ],
     "message": "Glad we could come to an agreement.",
     "metadata": {
-      "field1": "value1"
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
+      "custom_id": 1234,
+      "custom_text": "NDA #9"
     },
     "signer_list": [
       {

data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json

@@ -90,7 +90,13 @@
     "hide_text_tags": false,
     "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
     "metadata": {
-      "field1": "value1"
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
+      "custom_id": 1234,
+      "custom_text": "NDA #9"
     },
     "populate_auto_fill_fields": false,
     "signers": [

data/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json

@@ -21,7 +21,13 @@
     ],
     "message": "Glad we could come to an agreement.",
     "metadata": {
-      "field1": "value1"
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
+      "custom_id": 1234,
+      "custom_text": "NDA #9"
     },
     "populate_auto_fill_fields": false,
     "signers": [

data/test_fixtures/SignatureRequestGetResponse.json

@@ -6,7 +6,15 @@
       "original_title": "The NDA we talked about",
       "subject": "The NDA we talked about",
       "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
-      "metadata": {},
+      "metadata": {
+        "metadata_name_1": "metadata_value_1",
+        "metadata_name_2": {
+          "metadata_name_2_a": "metadata_value_2_a"
+        },
+        "metadata_name_3": "metadata_value_3",
+        "custom_id": 1234,
+        "custom_text": "NDA #9"
+      },
       "created_at": 1570471067,
       "is_complete": false,
       "is_declined": false,
@@ -91,6 +99,7 @@
           "required": true,
           "api_id": "initial__1",
           "value": "YM",
+          "is_signed": true,
           "signature_id": "a9f4825edef25f47e7b4c14ce8100d81d1693160"
         },
         {
@@ -107,6 +116,7 @@
           "required": true,
           "api_id": "signature__1",
           "value": "John Doe",
+          "is_signed": true,
           "signature_id": "a9f4825edef25f47e7b4c14ce8100d81d1693160"
         }
       ],

data/test_fixtures/SignatureRequestListResponse.json

@@ -13,7 +13,15 @@
         "original_title": "FHA",
         "subject": "FHA",
         "message": "Let me know if you two have any questions.",
-        "metadata": {},
+        "metadata": {
+          "metadata_name_1": "metadata_value_1",
+          "metadata_name_2": {
+            "metadata_name_2_a": "metadata_value_2_a"
+          },
+          "metadata_name_3": "metadata_value_3",
+          "custom_id": 1234,
+          "custom_text": "NDA #9"
+        },
         "created_at": 1570471067,
         "expires_at": 0,
         "is_complete": false,

data/test_fixtures/SignatureRequestSendRequest.json

@@ -192,6 +192,11 @@
     "is_eid": false,
     "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.",
     "metadata": {
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
       "custom_id": 1234,
       "custom_text": "NDA #9"
     },
@@ -472,4 +477,3 @@
     "use_text_tags": true
   }
 }
-

data/test_fixtures/SignatureRequestSendWithTemplateRequest.json

@@ -20,7 +20,13 @@
     "is_eid": false,
     "message": "Glad we could come to an agreement.",
     "metadata": {
-      "field1": "value1"
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
+      "custom_id": 1234,
+      "custom_text": "NDA #9"
     },
     "signers": [
       {

data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json

@@ -96,6 +96,11 @@
     ],
     "message": "For your approval",
     "metadata": {
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
       "custom_id": 1234,
       "custom_text": "NDA #9"
     },

data/test_fixtures/TemplateCreateRequest.json

@@ -96,6 +96,11 @@
     ],
     "message": "For your approval",
     "metadata": {
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
       "custom_id": 1234,
       "custom_text": "NDA #9"
     },

data/test_fixtures/TemplateGetResponse.json

@@ -9,7 +9,15 @@
       "is_creator": true,
       "is_embedded": false,
       "is_locked": false,
-      "metadata": {},
+      "metadata": {
+        "metadata_name_1": "metadata_value_1",
+        "metadata_name_2": {
+          "metadata_name_2_a": "metadata_value_2_a"
+        },
+        "metadata_name_3": "metadata_value_3",
+        "custom_id": 1234,
+        "custom_text": "NDA #9"
+      },
       "signer_roles": [
         {
           "name": "Outside Vendor",

data/test_fixtures/TemplateListResponse.json

@@ -16,7 +16,15 @@
         "is_creator": true,
         "is_embedded": false,
         "is_locked": false,
-        "metadata": {},
+        "metadata": {
+          "metadata_name_1": "metadata_value_1",
+          "metadata_name_2": {
+            "metadata_name_2_a": "metadata_value_2_a"
+          },
+          "metadata_name_3": "metadata_value_3",
+          "custom_id": 1234,
+          "custom_text": "NDA #9"
+        },
         "signer_roles": [
           {
             "name": "Client",

data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json

@@ -99,6 +99,11 @@
     "is_for_embedded_signing": true,
     "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.",
     "metadata": {
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
       "custom_id": 1234,
       "custom_text": "NDA #9"
     },

data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json

@@ -33,6 +33,11 @@
     "is_for_embedded_signing": true,
     "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.",
     "metadata": {
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
       "custom_id": 1234,
       "custom_text": "NDA #9"
     },

data/test_fixtures/UnclaimedDraftCreateRequest.json

@@ -88,6 +88,11 @@
     "hide_text_tags": true,
     "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.",
     "metadata": {
+      "metadata_name_1": "metadata_value_1",
+      "metadata_name_2": {
+        "metadata_name_2_a": "metadata_value_2_a"
+      },
+      "metadata_name_3": "metadata_value_3",
       "custom_id": 1234,
       "custom_text": "NDA #9"
     },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropbox-sign
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Dropbox
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-29 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus