Merge main -> oas-release

examples/FaxFiles.rb

@@ -7,11 +7,11 @@
 
 fax_api = Dropbox::Sign::FaxApi.new
 
-faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967";
+faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
 
 begin
-    file_bin = fax_api.fax_files(data)
-    FileUtils.cp(file_bin.path, "path/to/file.pdf")
+  file_bin = fax_api.fax_files(data)
+  FileUtils.cp(file_bin.path, "path/to/file.pdf")
 rescue Dropbox::Sign::ApiError => e
   puts "Exception when calling Dropbox Sign API: #{e}"
 end

openapi-raw.yaml

@@ -10565,6 +10565,10 @@ components:
             bulk_send_job_id:
               description: '_t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID'
               type: string
+            metadata:
+              description: '_t__SignatureRequestResponse::METADATA'
+              type: object
+              additionalProperties: {  }
       x-internal-class: true
     EmbeddedEditUrlResponseEmbedded:
       description: '_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION'
@@ -10609,13 +10613,11 @@ components:
         - fax_id
         - title
         - original_title
-        - subject
-        - message
         - metadata
         - created_at
         - sender
-        - transmissions
         - files_url
+        - transmissions
       properties:
         fax_id:
           description: '_t__FaxResponse::FAX_ID'
@@ -10629,9 +10631,11 @@ components:
         subject:
           description: '_t__FaxResponse::SUBJECT'
           type: string
+          nullable: true
         message:
           description: '_t__FaxResponse::MESSAGE'
           type: string
+          nullable: true
         metadata:
           description: '_t__FaxResponse::METADATA'
           type: object
@@ -10642,14 +10646,18 @@ components:
         sender:
           description: '_t__FaxResponse::SENDER'
           type: string
+        files_url:
+          description: '_t__FaxResponse::FILES_URL'
+          type: string
+        final_copy_uri:
+          description: '_t__FaxResponse::FINAL_COPY_URI'
+          type: string
+          nullable: true
         transmissions:
           description: '_t__FaxResponse::TRANSMISSIONS'
           type: array
           items:
             $ref: '#/components/schemas/FaxResponseTransmission'
-        files_url:
-          description: '_t__FaxResponse::FILES_URL'
-          type: string
       type: object
       x-internal-class: true
     FaxLineResponseFaxLine:
@@ -10672,15 +10680,11 @@ components:
     FaxResponseTransmission:
       required:
         - recipient
-        - sender
         - status_code
       properties:
         recipient:
           description: '_t__Sub::FaxResponseTransmission::RECIPIENT'
           type: string
-        sender:
-          description: '_t__Sub::FaxResponseTransmission::SENDER'
-          type: string
         status_code:
           description: '_t__Sub::FaxResponseTransmission::STATUS_CODE'
           type: string
@@ -10744,13 +10748,13 @@ components:
           description: '_t__SignatureRequestResponse::TEST_MODE'
           type: boolean
           default: false
-          nullable: true
         signature_request_id:
           description: '_t__SignatureRequestResponse::SIGNATURE_REQUEST_ID'
           type: string
         requester_email_address:
           description: '_t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS'
           type: string
+          nullable: true
         title:
           description: '_t__SignatureRequestResponse::TITLE'
           type: string
@@ -10768,12 +10772,14 @@ components:
         metadata:
           description: '_t__SignatureRequestResponse::METADATA'
           type: object
+          additionalProperties: {  }
         created_at:
           description: '_t__SignatureRequestResponse::CREATED_AT'
           type: integer
         expires_at:
           description: '_t__SignatureRequestResponse::EXPIRES_AT'
           type: integer
+          nullable: true
         is_complete:
           description: '_t__SignatureRequestResponse::IS_COMPLETE'
           type: boolean
@@ -10893,6 +10899,7 @@ components:
         editor:
           description: '_t__SignatureRequestResponseCustomField::EDITOR'
           type: string
+          nullable: true
       type: object
       discriminator:
         propertyName: type
@@ -10903,13 +10910,12 @@ components:
       x-base-class: true
     SignatureRequestResponseCustomFieldCheckbox:
       description: '_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS'
+      required:
+        - type
       allOf:
         -
           $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
         -
-          required:
-            - name
-            - type
           properties:
             type:
               description: '_t__SignatureRequestResponseCustomField::TYPE'
@@ -10921,13 +10927,12 @@ components:
           type: object
     SignatureRequestResponseCustomFieldText:
       description: '_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS'
+      required:
+        - type
       allOf:
         -
           $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
         -
-          required:
-            - name
-            - type
           properties:
             type:
               description: '_t__SignatureRequestResponseCustomField::TYPE'
@@ -11055,6 +11060,10 @@ components:
             value:
               description: '_t__SignatureRequestResponseDataValue::VALUE'
               type: string
+            is_signed:
+              description: '_t__SignatureRequestResponseDataValue::IS_SIGNED'
+              type: boolean
+              nullable: true
           type: object
     SignatureRequestResponseDataValueRadio:
       allOf:
@@ -11083,6 +11092,10 @@ components:
             value:
               description: '_t__SignatureRequestResponseDataValue::VALUE'
               type: string
+            is_signed:
+              description: '_t__SignatureRequestResponseDataValue::IS_SIGNED'
+              type: boolean
+              nullable: true
           type: object
     SignatureRequestResponseDataValueText:
       allOf:
@@ -11317,6 +11330,7 @@ components:
         metadata:
           description: '_t__TemplateResponse::METADATA'
           type: object
+          additionalProperties: {  }
         signer_roles:
           description: '_t__TemplateResponse::SIGNER_ROLES'
           type: array

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