Regenerated docs, added new translations, updated example template

Author: mchatlas-hellosign

examples/json/TemplateUpdateRequest.json

@@ -3,5 +3,15 @@
   "title": "Test Title",
   "subject": "Test Subject",
   "message": "Test Message",
-  "cc_roles": ["CC Role 1", "CC Role 2"]
+  "cc_roles": ["CC Role 1", "CC Role 2"],
+  "form_fields": [
+    {
+      "api_id": "uniqueIdHere_1",
+      "name": "New name 1"
+    },
+    {
+      "api_id": "uniqueIdHere_2",
+      "name": "New name 2"
+    }
+  ]
 }

openapi-raw.yaml

@@ -9467,6 +9467,17 @@ components:
               type: integer
               default: 12
           type: object
+    SubUpdateFormField:
+      required:
+        - api_id
+      properties:
+        api_id:
+          description: '_t__Sub::UpdateFormField::API_ID'
+          type: string
+        name:
+          description: '_t__Sub::UpdateFormField::NAME'
+          type: string
+      type: object
     SubFormFieldsPerDocumentHyperlink:
       description: '_t__Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS'
       allOf:
@@ -10325,6 +10336,11 @@ components:
           description: '_t__TemplateUpdate::MESSAGE'
           type: string
           maxLength: 5000
+        form_fields:
+          description: '_t__TemplateUpdate::FORM_FIELDS'
+          type: array
+          items:
+            $ref: '#/components/schemas/SubUpdateFormField'
       type: object
     TemplateUpdateFilesRequest:
       properties:

openapi-sdk.yaml

@@ -7249,8 +7249,8 @@ paths:
     post:
       tags:
         - Template
-      summary: 'Edit Template'
-      description: 'Edit template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.'
+      summary: 'Update Template'
+      description: 'Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.'
       operationId: templateUpdate
       parameters:
         -
@@ -9955,6 +9955,17 @@ components:
               type: integer
               default: 12
           type: object
+    SubUpdateFormField:
+      required:
+        - api_id
+      properties:
+        api_id:
+          description: 'The unique ID for this field. The endpoint will update an existing field with matching `api_id`, and warn you if no matches are found'
+          type: string
+        name:
+          description: 'The new name of the field. If not passed the name will remain unchanged.'
+          type: string
+      type: object
     SubFormFieldsPerDocumentHyperlink:
       description: 'This class extends `SubFormFieldsPerDocumentBase`.'
       allOf:
@@ -10962,6 +10973,11 @@ components:
           description: 'The new default template email message.'
           type: string
           maxLength: 5000
+        form_fields:
+          description: 'A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.'
+          type: array
+          items:
+            $ref: '#/components/schemas/SubUpdateFormField'
       type: object
     TemplateUpdateFilesRequest:
       properties:

openapi.yaml

@@ -9818,6 +9818,17 @@ components:
               type: integer
               default: 12
           type: object
+    SubUpdateFormField:
+      required:
+        - api_id
+      properties:
+        api_id:
+          description: 'The unique ID for this field. The endpoint will update an existing field with matching `api_id`, and warn you if no matches are found'
+          type: string
+        name:
+          description: 'The new name of the field. If not passed the name will remain unchanged.'
+          type: string
+      type: object
     SubFormFieldsPerDocumentHyperlink:
       description: 'This class extends `SubFormFieldsPerDocumentBase`.'
       allOf:
@@ -10825,6 +10836,11 @@ components:
           description: 'The new default template email message.'
           type: string
           maxLength: 5000
+        form_fields:
+          description: 'A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.'
+          type: array
+          items:
+            $ref: '#/components/schemas/SubUpdateFormField'
       type: object
     TemplateUpdateFilesRequest:
       properties:

test_fixtures/TemplateUpdateRequest.json

@@ -4,6 +4,16 @@
     "title": "Test Title",
     "subject": "Test Subject",
     "message": "Test Message",
-    "cc_roles": ["one", "two"]
+    "cc_roles": ["one", "two"],
+    "form_fields": [
+      {
+        "api_id": "uniqueIdHere_1",
+        "name": "New name 1"
+      },
+      {
+        "api_id": "uniqueIdHere_2",
+        "name": "New name 2"
+      }
+    ]
   }
 }

translations/en.yaml

@@ -777,11 +777,12 @@
 "TemplateRemoveUser::EMAIL_ADDRESS": The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.
 "TemplateRemoveUser::TEMPLATE_ID": The id of the Template to remove the Account's access to.
 
-"TemplateUpdate::SUMMARY": Edit Template
-"TemplateUpdate::DESCRIPTION": Edit template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.
+"TemplateUpdate::SUMMARY": Update Template
+"TemplateUpdate::DESCRIPTION": Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.
 "TemplateUpdate::TEMPLATE_ID": The ID of the template to update.
 "TemplateUpdate::CC_ROLES": The CC roles that must be assigned when using the template to send a signature request.
 "TemplateUpdate::ALLOW_FORM_VIEW": "The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names."
+"TemplateUpdate::FORM_FIELDS": A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.
 "TemplateUpdate::TITLE": The title you want to assign to the SignatureRequest.
 "TemplateUpdate::SUBJECT": The new default template email subject.
 "TemplateUpdate::MESSAGE": The new default template email message.
@@ -1230,6 +1231,9 @@
 "Sub::SigningOptions::TYPE": Allows typing the signature
 "Sub::SigningOptions::UPLOAD": Allows uploading the signature
 
+"Sub::UpdateFormField::API_ID": The unique ID for this field. The endpoint will update an existing field with matching `api_id`, and warn you if no matches are found
+"Sub::UpdateFormField::NAME": The new name of the field. If not passed the name will remain unchanged.
+
 "Sub::UnclaimedDraftSigner::DESCRIPTION": Add Signers to your Unclaimed Draft Signature Request.
 "Sub::UnclaimedDraftSigner::EMAIL_ADDRESS": The email address of the signer.
 "Sub::UnclaimedDraftSigner::NAME": The name of the signer.