dropbox-sign 1.7.0 → 1.9.0

data/run-build

@@ -18,7 +18,7 @@ rm -f "${DIR}/lib/dropbox-sign/models/"*.rb
 
 docker run --rm \
   -v "${DIR}/:/local" \
-  openapitools/openapi-generator-cli:v7.8.0 generate \
+  openapitools/openapi-generator-cli:v7.12.0 generate \
     -i "/local/openapi-sdk.yaml" \
     -c "/local/openapi-config.yaml" \
     -t "/local/templates" \

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.8.0
+Generator version: 7.12.0
 
 =end
 

data/templates/README.mustache

@@ -110,9 +110,9 @@ require '{{{gemName}}}'
   # Configure a proc to get access tokens in lieu of the static access_token configuration
   config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
   # Configure API key authorization: {{{name}}}
-  config.api_key['{{{name}}}'] = 'YOUR API KEY'
+  config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
+  # config.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
   # Configure OAuth2 access token for authorization: {{{name}}}
   config.access_token = 'YOUR ACCESS TOKEN'
   # Configure a proc to get access tokens in lieu of the static access_token configuration

data/templates/api_client_typhoeus_partial.mustache

@@ -4,7 +4,8 @@
     #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
-      tempfile = download_file(request) if opts[:return_type] == 'File'
+      tempfile = nil
+      (download_file(request) { tempfile = _1 }) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -145,17 +146,15 @@
         chunk.force_encoding(encoding)
         tempfile.write(chunk)
       end
-      # run the request to ensure the tempfile is created successfully before returning it
-      request.run
-      if tempfile
+      request.on_complete do
+        if !tempfile
+          fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}")
+        end
         tempfile.close
         @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
                             "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
                             "will be deleted automatically with GC. It's also recommended to delete the temp file "\
                             "explicitly with `tempfile.delete`"
-      else
-        fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") 
+        yield tempfile if block_given?
       end
-
-      tempfile
     end

data/templates/api_doc.mustache

@@ -50,9 +50,9 @@ require '{{{gemName}}}'
   # Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
   config.access_token = 'YOUR_BEARER_TOKEN'{{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
   # Configure API key authorization: {{{name}}}
-  config.api_key['{{{name}}}'] = 'YOUR API KEY'
+  config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
+  # config.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
   # Configure OAuth2 access token for authorization: {{{name}}}
   config.access_token = 'YOUR ACCESS TOKEN'{{/isOAuth}}
 {{/authMethods}}end

data/templates/configuration.mustache

@@ -237,7 +237,7 @@ module {{moduleName}}
             type: 'api_key',
             in: {{#isKeyInHeader}}'header'{{/isKeyInHeader}}{{#isKeyInQuery}}'query'{{/isKeyInQuery}},
             key: '{{keyParamName}}',
-            value: api_key_with_prefix('{{name}}'{{#vendorExtensions.x-auth-id-alias}}, '{{.}}'{{/vendorExtensions.x-auth-id-alias}})
+            value: api_key_with_prefix('{{keyParamName}}'{{#vendorExtensions.x-auth-id-alias}}, '{{.}}'{{/vendorExtensions.x-auth-id-alias}})
           },
 {{/isApiKey}}
 {{#isBasic}}

data/templates/partial_model_generic.mustache

@@ -45,16 +45,21 @@
       }
     end
 
-    # Returns all the JSON keys this model knows about{{#parent}}, including the ones defined in its parent(s){{/parent}}
-    def self.acceptable_attributes
+    # Returns attribute mapping this model knows about{{#parent}}, including the ones defined in its parent(s){{/parent}}
+    def self.acceptable_attribute_map
       {{^parent}}
-      attribute_map.values
+      attribute_map
       {{/parent}}
       {{#parent}}
-      attribute_map.values.concat(superclass.acceptable_attributes)
+      superclass.acceptable_attribute_map.merge(attribute_map)
       {{/parent}}
     end
 
+    # Returns all the JSON keys this model knows about{{#parent}}, including the ones defined in its parent(s){{/parent}}
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
@@ -182,14 +187,15 @@
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
 {{^useCustomTemplateCode}}
-        if (!self.class.attribute_map.key?(k.to_sym))
+        if (!acceptable_attribute_map.key?(k.to_sym))
 {{/useCustomTemplateCode}}
 {{#useCustomTemplateCode}}
         if (!self.class.merged_attributes.key?(k.to_sym))
 {{/useCustomTemplateCode}}
-          fail ArgumentError, "`#{k}` is not a valid attribute in `{{{moduleName}}}::{{{classname}}}`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `{{{moduleName}}}::{{{classname}}}`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -437,6 +443,22 @@
       @{{{name}}} = {{{name}}}
     end
 
+    {{/hasValidation}}
+    {{^hasValidation}}
+    {{^isNullable}}
+    {{#required}}
+    # Custom attribute writer method with validation
+    # @param [Object] {{{name}}} Value to be assigned
+    def {{{name}}}=({{{name}}})
+      if {{{name}}}.nil?
+        fail ArgumentError, '{{{name}}} cannot be nil'
+      end
+
+      @{{{name}}} = {{{name}}}
+    end
+
+    {{/required}}
+    {{/isNullable}}
     {{/hasValidation}}
     {{/isEnum}}
     {{/vars}}

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"
     },