dropbox-sign 1.6.1 → 1.8.0

data/openapi-sdk.yaml

@@ -1409,6 +1409,304 @@ paths:
         seo:
           title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers'
           description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.'
+  '/fax/{fax_id}':
+    get:
+      tags:
+        - Fax
+      summary: 'Get Fax'
+      description: 'Returns information about fax'
+      operationId: faxGet
+      parameters:
+        -
+          name: fax_id
+          in: path
+          description: 'Fax ID'
+          required: true
+          schema:
+            type: string
+          example: fa5c8a0b0f492d768749333ad6fcc214c111e967
+      responses:
+        200:
+          description: 'successful operation'
+          headers:
+            X-RateLimit-Limit:
+              $ref: '#/components/headers/X-RateLimit-Limit'
+            X-RateLimit-Remaining:
+              $ref: '#/components/headers/X-RateLimit-Remaining'
+            X-Ratelimit-Reset:
+              $ref: '#/components/headers/X-Ratelimit-Reset'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/FaxGetResponse'
+              examples:
+                default_example:
+                  $ref: '#/components/examples/FaxGetResponseExample'
+        4XX:
+          description: failed_operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                400_example:
+                  $ref: '#/components/examples/Error400ResponseExample'
+                401_example:
+                  $ref: '#/components/examples/Error401ResponseExample'
+                402_example:
+                  $ref: '#/components/examples/Error402ResponseExample'
+                403_example:
+                  $ref: '#/components/examples/Error403ResponseExample'
+                404_example:
+                  $ref: '#/components/examples/Error404ResponseExample'
+                429_example:
+                  $ref: '#/components/examples/Error429ResponseExample'
+                4XX_example:
+                  $ref: '#/components/examples/Error4XXResponseExample'
+      security:
+        -
+          api_key: []
+      x-codeSamples:
+        -
+          lang: PHP
+          label: PHP
+          source:
+            $ref: examples/FaxGet.php
+        -
+          lang: 'C#'
+          label: 'C#'
+          source:
+            $ref: examples/FaxGet.cs
+        -
+          lang: JavaScript
+          label: JavaScript
+          source:
+            $ref: examples/FaxGet.js
+        -
+          lang: TypeScript
+          label: TypeScript
+          source:
+            $ref: examples/FaxGet.ts
+        -
+          lang: Java
+          label: Java
+          source:
+            $ref: examples/FaxGet.java
+        -
+          lang: Ruby
+          label: Ruby
+          source:
+            $ref: examples/FaxGet.rb
+        -
+          lang: Python
+          label: Python
+          source:
+            $ref: examples/FaxGet.py
+        -
+          lang: cURL
+          label: cURL
+          source:
+            $ref: examples/FaxGet.sh
+      x-meta:
+        seo:
+          title: 'Get Fax | API Documentation | Dropbox Fax for Developers'
+          description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.'
+    delete:
+      tags:
+        - Fax
+      summary: 'Delete Fax'
+      description: 'Deletes the specified Fax from the system.'
+      operationId: faxDelete
+      parameters:
+        -
+          name: fax_id
+          in: path
+          description: 'Fax ID'
+          required: true
+          schema:
+            type: string
+          example: fa5c8a0b0f492d768749333ad6fcc214c111e967
+      responses:
+        204:
+          description: 'successful operation'
+          headers:
+            X-RateLimit-Limit:
+              $ref: '#/components/headers/X-RateLimit-Limit'
+            X-RateLimit-Remaining:
+              $ref: '#/components/headers/X-RateLimit-Remaining'
+            X-Ratelimit-Reset:
+              $ref: '#/components/headers/X-Ratelimit-Reset'
+        4XX:
+          description: failed_operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                400_example:
+                  $ref: '#/components/examples/Error400ResponseExample'
+                401_example:
+                  $ref: '#/components/examples/Error401ResponseExample'
+                402_example:
+                  $ref: '#/components/examples/Error402ResponseExample'
+                403_example:
+                  $ref: '#/components/examples/Error403ResponseExample'
+                404_example:
+                  $ref: '#/components/examples/Error404ResponseExample'
+                429_example:
+                  $ref: '#/components/examples/Error429ResponseExample'
+                4XX_example:
+                  $ref: '#/components/examples/Error4XXResponseExample'
+      security:
+        -
+          api_key: []
+      x-codeSamples:
+        -
+          lang: PHP
+          label: PHP
+          source:
+            $ref: examples/FaxDelete.php
+        -
+          lang: 'C#'
+          label: 'C#'
+          source:
+            $ref: examples/FaxDelete.cs
+        -
+          lang: JavaScript
+          label: JavaScript
+          source:
+            $ref: examples/FaxDelete.js
+        -
+          lang: TypeScript
+          label: TypeScript
+          source:
+            $ref: examples/FaxDelete.ts
+        -
+          lang: Java
+          label: Java
+          source:
+            $ref: examples/FaxDelete.java
+        -
+          lang: Ruby
+          label: Ruby
+          source:
+            $ref: examples/FaxDelete.rb
+        -
+          lang: Python
+          label: Python
+          source:
+            $ref: examples/FaxDelete.py
+        -
+          lang: cURL
+          label: cURL
+          source:
+            $ref: examples/FaxDelete.sh
+      x-meta:
+        seo:
+          title: 'Delete Fax | API Documentation | Dropbox Fax for Developers'
+          description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here.'
+  '/fax/files/{fax_id}':
+    get:
+      tags:
+        - Fax
+      summary: 'List Fax Files'
+      description: 'Returns list of fax files'
+      operationId: faxFiles
+      parameters:
+        -
+          name: fax_id
+          in: path
+          description: 'Fax ID'
+          required: true
+          schema:
+            type: string
+          example: fa5c8a0b0f492d768749333ad6fcc214c111e967
+      responses:
+        200:
+          description: 'successful operation'
+          headers:
+            X-RateLimit-Limit:
+              $ref: '#/components/headers/X-RateLimit-Limit'
+            X-RateLimit-Remaining:
+              $ref: '#/components/headers/X-RateLimit-Remaining'
+            X-Ratelimit-Reset:
+              $ref: '#/components/headers/X-Ratelimit-Reset'
+          content:
+            application/pdf:
+              schema:
+                type: string
+                format: binary
+        4XX:
+          description: failed_operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                400_example:
+                  $ref: '#/components/examples/Error400ResponseExample'
+                401_example:
+                  $ref: '#/components/examples/Error401ResponseExample'
+                402_example:
+                  $ref: '#/components/examples/Error402ResponseExample'
+                403_example:
+                  $ref: '#/components/examples/Error403ResponseExample'
+                404_example:
+                  $ref: '#/components/examples/Error404ResponseExample'
+                410_example:
+                  $ref: '#/components/examples/Error410ResponseExample'
+                429_example:
+                  $ref: '#/components/examples/Error429ResponseExample'
+                4XX_example:
+                  $ref: '#/components/examples/Error4XXResponseExample'
+      security:
+        -
+          api_key: []
+      x-codeSamples:
+        -
+          lang: PHP
+          label: PHP
+          source:
+            $ref: examples/FaxFiles.php
+        -
+          lang: 'C#'
+          label: 'C#'
+          source:
+            $ref: examples/FaxFiles.cs
+        -
+          lang: JavaScript
+          label: JavaScript
+          source:
+            $ref: examples/FaxFiles.js
+        -
+          lang: TypeScript
+          label: TypeScript
+          source:
+            $ref: examples/FaxFiles.ts
+        -
+          lang: Java
+          label: Java
+          source:
+            $ref: examples/FaxFiles.java
+        -
+          lang: Ruby
+          label: Ruby
+          source:
+            $ref: examples/FaxFiles.rb
+        -
+          lang: Python
+          label: Python
+          source:
+            $ref: examples/FaxFiles.py
+        -
+          lang: cURL
+          label: cURL
+          source:
+            $ref: examples/FaxFiles.sh
+      x-meta:
+        seo:
+          title: 'Fax Files | API Documentation | Dropbox Fax for Developers'
+          description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.'
   /fax_line/add_user:
     put:
       tags:
@@ -2023,7 +2321,216 @@ paths:
           in: query
           description: 'Show team lines'
           schema:
-            type: boolean
+            type: boolean
+      responses:
+        200:
+          description: 'successful operation'
+          headers:
+            X-RateLimit-Limit:
+              $ref: '#/components/headers/X-RateLimit-Limit'
+            X-RateLimit-Remaining:
+              $ref: '#/components/headers/X-RateLimit-Remaining'
+            X-Ratelimit-Reset:
+              $ref: '#/components/headers/X-Ratelimit-Reset'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/FaxLineListResponse'
+              examples:
+                default_example:
+                  $ref: '#/components/examples/FaxLineListResponseExample'
+        4XX:
+          description: failed_operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                400_example:
+                  $ref: '#/components/examples/Error400ResponseExample'
+                401_example:
+                  $ref: '#/components/examples/Error401ResponseExample'
+                402_example:
+                  $ref: '#/components/examples/Error402ResponseExample'
+                403_example:
+                  $ref: '#/components/examples/Error403ResponseExample'
+                4XX_example:
+                  $ref: '#/components/examples/Error4XXResponseExample'
+      security:
+        -
+          api_key: []
+      x-codeSamples:
+        -
+          lang: PHP
+          label: PHP
+          source:
+            $ref: examples/FaxLineList.php
+        -
+          lang: 'C#'
+          label: 'C#'
+          source:
+            $ref: examples/FaxLineList.cs
+        -
+          lang: JavaScript
+          label: JavaScript
+          source:
+            $ref: examples/FaxLineList.js
+        -
+          lang: TypeScript
+          label: TypeScript
+          source:
+            $ref: examples/FaxLineList.ts
+        -
+          lang: Java
+          label: Java
+          source:
+            $ref: examples/FaxLineList.java
+        -
+          lang: Ruby
+          label: Ruby
+          source:
+            $ref: examples/FaxLineList.rb
+        -
+          lang: Python
+          label: Python
+          source:
+            $ref: examples/FaxLineList.py
+        -
+          lang: cURL
+          label: cURL
+          source:
+            $ref: examples/FaxLineList.sh
+      x-meta:
+        seo:
+          title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers'
+          description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.'
+  /fax_line/remove_user:
+    put:
+      tags:
+        - 'Fax Line'
+      summary: 'Remove Fax Line Access'
+      description: 'Removes a user''s access to the specified Fax Line.'
+      operationId: faxLineRemoveUser
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/FaxLineRemoveUserRequest'
+            examples:
+              default_example:
+                $ref: '#/components/examples/FaxLineRemoveUserRequestExample'
+      responses:
+        200:
+          description: 'successful operation'
+          headers:
+            X-RateLimit-Limit:
+              $ref: '#/components/headers/X-RateLimit-Limit'
+            X-RateLimit-Remaining:
+              $ref: '#/components/headers/X-RateLimit-Remaining'
+            X-Ratelimit-Reset:
+              $ref: '#/components/headers/X-Ratelimit-Reset'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/FaxLineResponse'
+              examples:
+                default_example:
+                  $ref: '#/components/examples/FaxLineResponseExample'
+        4XX:
+          description: failed_operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                400_example:
+                  $ref: '#/components/examples/Error400ResponseExample'
+                401_example:
+                  $ref: '#/components/examples/Error401ResponseExample'
+                402_example:
+                  $ref: '#/components/examples/Error402ResponseExample'
+                403_example:
+                  $ref: '#/components/examples/Error403ResponseExample'
+                404_example:
+                  $ref: '#/components/examples/Error404ResponseExample'
+                4XX_example:
+                  $ref: '#/components/examples/Error4XXResponseExample'
+      security:
+        -
+          api_key: []
+      x-codeSamples:
+        -
+          lang: PHP
+          label: PHP
+          source:
+            $ref: examples/FaxLineRemoveUser.php
+        -
+          lang: 'C#'
+          label: 'C#'
+          source:
+            $ref: examples/FaxLineRemoveUser.cs
+        -
+          lang: JavaScript
+          label: JavaScript
+          source:
+            $ref: examples/FaxLineRemoveUser.js
+        -
+          lang: TypeScript
+          label: TypeScript
+          source:
+            $ref: examples/FaxLineRemoveUser.ts
+        -
+          lang: Java
+          label: Java
+          source:
+            $ref: examples/FaxLineRemoveUser.java
+        -
+          lang: Ruby
+          label: Ruby
+          source:
+            $ref: examples/FaxLineRemoveUser.rb
+        -
+          lang: Python
+          label: Python
+          source:
+            $ref: examples/FaxLineRemoveUser.py
+        -
+          lang: cURL
+          label: cURL
+          source:
+            $ref: examples/FaxLineRemoveUser.sh
+      x-meta:
+        seo:
+          title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers'
+          description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.'
+  /fax/list:
+    get:
+      tags:
+        - Fax
+      summary: 'Lists Faxes'
+      description: 'Returns properties of multiple faxes'
+      operationId: faxList
+      parameters:
+        -
+          name: page
+          in: query
+          description: Page
+          schema:
+            type: integer
+            default: 1
+            minimum: 1
+          example: 1
+        -
+          name: page_size
+          in: query
+          description: 'Page size'
+          schema:
+            type: integer
+            default: 20
+            maximum: 100
+            minimum: 1
+          example: 20
       responses:
         200:
           description: 'successful operation'
@@ -2037,10 +2544,10 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FaxLineListResponse'
+                $ref: '#/components/schemas/FaxListResponse'
               examples:
                 default_example:
-                  $ref: '#/components/examples/FaxLineListResponseExample'
+                  $ref: '#/components/examples/FaxListResponseExample'
         4XX:
           description: failed_operation
           content:
@@ -2066,62 +2573,65 @@ paths:
           lang: PHP
           label: PHP
           source:
-            $ref: examples/FaxLineList.php
+            $ref: examples/FaxList.php
         -
           lang: 'C#'
           label: 'C#'
           source:
-            $ref: examples/FaxLineList.cs
+            $ref: examples/FaxList.cs
         -
           lang: JavaScript
           label: JavaScript
           source:
-            $ref: examples/FaxLineList.js
+            $ref: examples/FaxList.js
         -
           lang: TypeScript
           label: TypeScript
           source:
-            $ref: examples/FaxLineList.ts
+            $ref: examples/FaxList.ts
         -
           lang: Java
           label: Java
           source:
-            $ref: examples/FaxLineList.java
+            $ref: examples/FaxList.java
         -
           lang: Ruby
           label: Ruby
           source:
-            $ref: examples/FaxLineList.rb
+            $ref: examples/FaxList.rb
         -
           lang: Python
           label: Python
           source:
-            $ref: examples/FaxLineList.py
+            $ref: examples/FaxList.py
         -
           lang: cURL
           label: cURL
           source:
-            $ref: examples/FaxLineList.sh
+            $ref: examples/FaxList.sh
       x-meta:
         seo:
-          title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers'
-          description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.'
-  /fax_line/remove_user:
-    put:
+          title: 'List Faxes | API Documentation | Dropbox Fax for Developers'
+          description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here.'
+  /fax/send:
+    post:
       tags:
-        - 'Fax Line'
-      summary: 'Remove Fax Line Access'
-      description: 'Removes a user''s access to the specified Fax Line.'
-      operationId: faxLineRemoveUser
+        - Fax
+      summary: 'Send Fax'
+      description: 'Action to prepare and send a fax'
+      operationId: faxSend
       requestBody:
         required: true
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/FaxLineRemoveUserRequest'
+              $ref: '#/components/schemas/FaxSendRequest'
             examples:
               default_example:
-                $ref: '#/components/examples/FaxLineRemoveUserRequestExample'
+                $ref: '#/components/examples/FaxSendRequestExample'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/FaxSendRequest'
       responses:
         200:
           description: 'successful operation'
@@ -2135,10 +2645,10 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FaxLineResponse'
+                $ref: '#/components/schemas/FaxGetResponse'
               examples:
                 default_example:
-                  $ref: '#/components/examples/FaxLineResponseExample'
+                  $ref: '#/components/examples/FaxGetResponseExample'
         4XX:
           description: failed_operation
           content:
@@ -2156,6 +2666,8 @@ paths:
                   $ref: '#/components/examples/Error403ResponseExample'
                 404_example:
                   $ref: '#/components/examples/Error404ResponseExample'
+                429_example:
+                  $ref: '#/components/examples/Error429ResponseExample'
                 4XX_example:
                   $ref: '#/components/examples/Error4XXResponseExample'
       security:
@@ -2166,46 +2678,46 @@ paths:
           lang: PHP
           label: PHP
           source:
-            $ref: examples/FaxLineRemoveUser.php
+            $ref: examples/FaxSend.php
         -
           lang: 'C#'
           label: 'C#'
           source:
-            $ref: examples/FaxLineRemoveUser.cs
+            $ref: examples/FaxSend.cs
         -
           lang: JavaScript
           label: JavaScript
           source:
-            $ref: examples/FaxLineRemoveUser.js
+            $ref: examples/FaxSend.js
         -
           lang: TypeScript
           label: TypeScript
           source:
-            $ref: examples/FaxLineRemoveUser.ts
+            $ref: examples/FaxSend.ts
         -
           lang: Java
           label: Java
           source:
-            $ref: examples/FaxLineRemoveUser.java
+            $ref: examples/FaxSend.java
         -
           lang: Ruby
           label: Ruby
           source:
-            $ref: examples/FaxLineRemoveUser.rb
+            $ref: examples/FaxSend.rb
         -
           lang: Python
           label: Python
           source:
-            $ref: examples/FaxLineRemoveUser.py
+            $ref: examples/FaxSend.py
         -
           lang: cURL
           label: cURL
           source:
-            $ref: examples/FaxLineRemoveUser.sh
+            $ref: examples/FaxSend.sh
       x-meta:
         seo:
-          title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers'
-          description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.'
+          title: 'Send Fax| API Documentation | Dropbox Fax for Developers'
+          description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.'
   /oauth/token:
     post:
       tags:
@@ -2239,6 +2751,23 @@ paths:
               examples:
                 default_example:
                   $ref: '#/components/examples/OAuthTokenGenerateResponseExample'
+        4XX:
+          description: failed_operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                400_example:
+                  $ref: '#/components/examples/Error400ResponseExample'
+                401_example:
+                  $ref: '#/components/examples/Error401ResponseExample'
+                402_example:
+                  $ref: '#/components/examples/Error402ResponseExample'
+                403_example:
+                  $ref: '#/components/examples/Error403ResponseExample'
+                4XX_example:
+                  $ref: '#/components/examples/Error4XXResponseExample'
       security: []
       servers:
         -
@@ -2322,6 +2851,23 @@ paths:
               examples:
                 default_example:
                   $ref: '#/components/examples/OAuthTokenRefreshResponseExample'
+        4XX:
+          description: failed_operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                400_example:
+                  $ref: '#/components/examples/Error400ResponseExample'
+                401_example:
+                  $ref: '#/components/examples/Error401ResponseExample'
+                402_example:
+                  $ref: '#/components/examples/Error402ResponseExample'
+                403_example:
+                  $ref: '#/components/examples/Error403ResponseExample'
+                4XX_example:
+                  $ref: '#/components/examples/Error4XXResponseExample'
       security: []
       servers:
         -
@@ -2703,7 +3249,7 @@ paths:
 
         The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued.
 
-        This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a  [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.
+        This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.
 
         To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.
 
@@ -4617,7 +5163,7 @@ paths:
                 403_example:
                   $ref: '#/components/examples/Error403ResponseExample'
                 404_example:
-                  $ref: '#/components/examples/TeamDoesNotExistResponseExample'
+                  $ref: '#/components/examples/Error404ResponseExample'
                 4XX_example:
                   $ref: '#/components/examples/Error4XXResponseExample'
       security:
@@ -5440,7 +5986,7 @@ paths:
     post:
       tags:
         - Template
-      summary: 'Create  Template'
+      summary: 'Create Template'
       description: 'Creates a template that can then be used.'
       operationId: templateCreate
       requestBody:
@@ -7345,6 +7891,50 @@ components:
           type: string
           format: email
       type: object
+    FaxSendRequest:
+      required:
+        - recipient
+      properties:
+        recipient:
+          description: 'Fax Send To Recipient'
+          type: string
+          example: recipient@example.com
+        sender:
+          description: 'Fax Send From Sender (used only with fax number)'
+          type: string
+          example: sender@example.com
+        files:
+          description: 'Fax File to Send'
+          type: array
+          items:
+            type: string
+            format: binary
+        file_urls:
+          description: 'Fax File URL to Send'
+          type: array
+          items:
+            type: string
+        test_mode:
+          description: 'API Test Mode Setting'
+          type: boolean
+          default: false
+        cover_page_to:
+          description: 'Fax Cover Page for Recipient'
+          type: string
+          example: 'Recipient Name'
+        cover_page_from:
+          description: 'Fax Cover Page for Sender'
+          type: string
+          example: 'Sender Name'
+        cover_page_message:
+          description: 'Fax Cover Page Message'
+          type: string
+          example: 'Please find the attached documents.'
+        title:
+          description: 'Fax Title'
+          type: string
+          example: 'Fax Title'
+      type: object
     OAuthTokenGenerateRequest:
       required:
         - client_id
@@ -7382,6 +7972,12 @@ components:
         refresh_token:
           description: 'The token provided when you got the expired access token.'
           type: string
+        client_id:
+          description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
+          type: string
+        client_secret:
+          description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
+          type: string
       type: object
     ReportCreateRequest:
       required:
@@ -9091,7 +9687,7 @@ components:
       properties:
         header_background_color:
           type: string
-          default: '#1A1A1A'
+          default: '#1a1a1a'
         legal_version:
           type: string
           default: terms1
@@ -9100,40 +9696,40 @@ components:
             - terms2
         link_color:
           type: string
-          default: '#00B3E6'
+          default: '#0061FE'
         page_background_color:
           type: string
-          default: '#F7F8F9'
+          default: '#f7f8f9'
         primary_button_color:
           type: string
-          default: '#00B3E6'
+          default: '#0061FE'
         primary_button_color_hover:
           type: string
-          default: '#00B3E6'
+          default: '#0061FE'
         primary_button_text_color:
           type: string
-          default: '#FFFFFF'
+          default: '#ffffff'
         primary_button_text_color_hover:
           type: string
-          default: '#FFFFFF'
+          default: '#ffffff'
         secondary_button_color:
           type: string
-          default: '#FFFFFF'
+          default: '#ffffff'
         secondary_button_color_hover:
           type: string
-          default: '#FFFFFF'
+          default: '#ffffff'
         secondary_button_text_color:
           type: string
-          default: '#00B3E6'
+          default: '#0061FE'
         secondary_button_text_color_hover:
           type: string
-          default: '#00B3E6'
+          default: '#0061FE'
         text_color1:
           type: string
           default: '#808080'
         text_color2:
           type: string
-          default: '#FFFFFF'
+          default: '#ffffff'
         reset_to_default:
           description: 'Resets white labeling options to defaults. Only useful when updating an API App.'
           type: boolean
@@ -10211,6 +10807,19 @@ components:
         error:
           $ref: '#/components/schemas/ErrorResponseError'
       type: object
+    FaxGetResponse:
+      required:
+        - fax
+      properties:
+        fax:
+          $ref: '#/components/schemas/FaxResponse'
+        warnings:
+          description: 'A list of warnings.'
+          type: array
+          items:
+            $ref: '#/components/schemas/WarningResponse'
+      type: object
+      x-internal-class: true
     FaxLineResponse:
       required:
         - fax_line
@@ -10246,6 +10855,19 @@ components:
           $ref: '#/components/schemas/WarningResponse'
       type: object
       x-internal-class: true
+    FaxListResponse:
+      required:
+        - faxes
+        - list_info
+      properties:
+        faxes:
+          type: array
+          items:
+            $ref: '#/components/schemas/FaxResponse'
+        list_info:
+          $ref: '#/components/schemas/ListInfoResponse'
+      type: object
+      x-internal-class: true
     FileResponse:
       required:
         - file_url
@@ -10388,7 +11010,7 @@ components:
           type: integer
           nullable: true
         sms_verifications_left:
-          description: 'SMS verifications  remaining.'
+          description: 'SMS verifications remaining.'
           type: integer
           nullable: true
         num_fax_pages_left:
@@ -10456,6 +11078,7 @@ components:
         secret:
           description: 'The app''s OAuth secret, or null if the app does not belong to user.'
           type: string
+          nullable: true
         scopes:
           description: 'Array of OAuth scopes used by the app.'
           type: array
@@ -10550,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.'
@@ -10589,6 +11216,58 @@ components:
           description: 'Name of the error.'
           type: string
       type: object
+    FaxResponse:
+      required:
+        - fax_id
+        - title
+        - original_title
+        - metadata
+        - created_at
+        - sender
+        - files_url
+        - transmissions
+      properties:
+        fax_id:
+          description: 'Fax ID'
+          type: string
+        title:
+          description: 'Fax Title'
+          type: string
+        original_title:
+          description: 'Fax Original Title'
+          type: string
+        subject:
+          description: 'Fax Subject'
+          type: string
+          nullable: true
+        message:
+          description: 'Fax Message'
+          type: string
+          nullable: true
+        metadata:
+          description: 'Fax Metadata'
+          type: object
+          additionalProperties: {}
+        created_at:
+          description: 'Fax Created At Timestamp'
+          type: integer
+        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'
+      type: object
+      x-internal-class: true
     FaxLineResponseFaxLine:
       properties:
         number:
@@ -10606,6 +11285,31 @@ components:
             $ref: '#/components/schemas/AccountResponse'
       type: object
       x-internal-class: true
+    FaxResponseTransmission:
+      required:
+        - recipient
+        - status_code
+      properties:
+        recipient:
+          description: 'Fax Transmission Recipient'
+          type: string
+        status_code:
+          description: 'Fax Transmission Status Code'
+          type: string
+          enum:
+            - success
+            - transmitting
+            - error_could_not_fax
+            - error_unknown
+            - error_busy
+            - error_no_answer
+            - error_disconnected
+            - error_bad_destination
+        sent_at:
+          description: 'Fax Transmission Sent Timestamp'
+          type: integer
+      type: object
+      x-internal-class: true
     ListInfoResponse:
       description: 'Contains pagination information about the data returned.'
       properties:
@@ -10652,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
@@ -10676,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
@@ -10809,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
@@ -10819,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.'
@@ -10837,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.'
@@ -10971,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:
@@ -10999,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:
@@ -11218,27 +11931,25 @@ components:
           description: 'Time the template was last updated.'
           type: integer
         is_embedded:
-          description: '`true` if this template was created using an embedded flow, `false` if it was created on our website.'
+          description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.'
           type: boolean
           nullable: true
         is_creator:
           description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.'
           type: boolean
-          nullable: true
         can_edit:
           description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).'
           type: boolean
-          nullable: true
         is_locked:
           description: |-
             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.
           type: boolean
-          nullable: true
         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
@@ -11273,7 +11984,11 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/TemplateResponseAccount'
-          nullable: true
+        attachments:
+          description: 'Signer attachments.'
+          type: array
+          items:
+            $ref: '#/components/schemas/SignatureRequestResponseAttachment'
       type: object
       x-internal-class: true
     TemplateResponseAccount:
@@ -11377,7 +12092,6 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-          nullable: true
       type: object
       x-internal-class: true
     TemplateResponseDocumentCustomFieldBase:
@@ -11529,10 +12243,6 @@ components:
         required:
           description: 'Boolean showing whether or not this field is required.'
           type: boolean
-        group:
-          description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
-          type: string
-          nullable: true
       type: object
       discriminator:
         propertyName: type
@@ -11549,12 +12259,12 @@ components:
       x-base-class: true
     TemplateResponseDocumentFormFieldCheckbox:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+      required:
+        - type
       allOf:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11570,6 +12280,10 @@ components:
                 * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
               type: string
               default: checkbox
+            group:
+              description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+              type: string
+              nullable: true
           type: object
     TemplateResponseDocumentFormFieldDateSigned:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11579,8 +12293,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11596,6 +12308,10 @@ components:
                 * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
               type: string
               default: date_signed
+            group:
+              description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+              type: string
+              nullable: true
           type: object
     TemplateResponseDocumentFormFieldDropdown:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11605,8 +12321,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11622,6 +12336,10 @@ components:
                 * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
               type: string
               default: dropdown
+            group:
+              description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+              type: string
+              nullable: true
           type: object
     TemplateResponseDocumentFormFieldHyperlink:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11631,8 +12349,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11659,6 +12375,10 @@ components:
             fontFamily:
               description: 'Font family used in this form field''s text.'
               type: string
+            group:
+              description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+              type: string
+              nullable: true
           type: object
     TemplateResponseDocumentFormFieldInitials:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11668,8 +12388,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11685,6 +12403,10 @@ components:
                 * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
               type: string
               default: initials
+            group:
+              description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+              type: string
+              nullable: true
           type: object
     TemplateResponseDocumentFormFieldRadio:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11695,8 +12417,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11712,6 +12432,9 @@ components:
                 * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
               type: string
               default: radio
+            group:
+              description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+              type: string
           type: object
     TemplateResponseDocumentFormFieldSignature:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11721,8 +12444,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11738,6 +12459,10 @@ components:
                 * Initials Field uses `TemplateResponseDocumentFormFieldInitials`
               type: string
               default: signature
+            group:
+              description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+              type: string
+              nullable: true
           type: object
     TemplateResponseDocumentFormFieldText:
       description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11747,8 +12472,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11790,6 +12513,10 @@ components:
                 - employer_identification_number
                 - custom_regex
               nullable: true
+            group:
+              description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+              type: string
+              nullable: true
           type: object
     TemplateResponseDocumentStaticFieldBase:
       description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.'
@@ -11849,8 +12576,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11875,8 +12600,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11901,8 +12624,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11927,8 +12648,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11953,8 +12672,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -11979,8 +12696,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -12005,8 +12720,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -12031,8 +12744,6 @@ components:
         -
           $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
         -
-          required:
-            - type
           properties:
             type:
               description: |-
@@ -12418,6 +13129,10 @@ components:
       summary: 'Default Example'
       value:
         $ref: examples/json/FaxLineRemoveUserRequestExample.json
+    FaxSendRequestExample:
+      summary: 'Default Example'
+      value:
+        $ref: examples/json/FaxSendRequestExample.json
     OAuthTokenGenerateRequestExample:
       summary: 'OAuth Token Generate Example'
       value:
@@ -12662,6 +13377,10 @@ components:
       summary: 'Error 4XX failed_operation'
       value:
         $ref: examples/json/Error4XXResponseExample.json
+    FaxGetResponseExample:
+      summary: 'Fax Response'
+      value:
+        $ref: examples/json/FaxGetResponseExample.json
     FaxLineResponseExample:
       summary: 'Sample Fax Line Response'
       value:
@@ -12674,6 +13393,10 @@ components:
       summary: 'Sample Fax Line List Response'
       value:
         $ref: examples/json/FaxLineListResponseExample.json
+    FaxListResponseExample:
+      summary: 'Returns the properties and settings of multiple Faxes.'
+      value:
+        $ref: examples/json/FaxListResponseExample.json
     ReportCreateResponseExample:
       summary: Report
       value: