hellosign-ruby-sdk 3.7.7 → 6.0.0.pre.beta

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1124) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +5 -8
  3. data/Gemfile.lock +76 -0
  4. data/LICENSE +2 -2
  5. data/README.md +283 -85
  6. data/Rakefile +7 -13
  7. data/bin/generate-examples.php +269 -0
  8. data/bin/php +15 -0
  9. data/bin/replace +10 -0
  10. data/bin/ruby +15 -0
  11. data/bin/scan_for +31 -0
  12. data/composer.json +10 -0
  13. data/composer.lock +246 -0
  14. data/docs/AccountApi.md +300 -0
  15. data/docs/AccountCreateRequest.md +13 -0
  16. data/docs/AccountCreateResponse.md +12 -0
  17. data/docs/AccountGetResponse.md +11 -0
  18. data/docs/AccountResponse.md +18 -0
  19. data/docs/AccountResponseQuotas.md +13 -0
  20. data/docs/AccountUpdateRequest.md +12 -0
  21. data/docs/AccountVerifyRequest.md +10 -0
  22. data/docs/AccountVerifyResponse.md +11 -0
  23. data/docs/AccountVerifyResponseAccount.md +10 -0
  24. data/docs/ApiAppApi.md +402 -0
  25. data/docs/ApiAppCreateRequest.md +16 -0
  26. data/docs/ApiAppGetResponse.md +11 -0
  27. data/docs/ApiAppListResponse.md +12 -0
  28. data/docs/ApiAppResponse.md +19 -0
  29. data/docs/ApiAppResponseOAuth.md +13 -0
  30. data/docs/ApiAppResponseOptions.md +10 -0
  31. data/docs/ApiAppResponseOwnerAccount.md +11 -0
  32. data/docs/ApiAppResponseWhiteLabelingOptions.md +23 -0
  33. data/docs/ApiAppUpdateRequest.md +16 -0
  34. data/docs/BulkSendJobApi.md +155 -0
  35. data/docs/BulkSendJobGetResponse.md +13 -0
  36. data/docs/BulkSendJobGetResponseSignatureRequests.md +32 -0
  37. data/docs/BulkSendJobListResponse.md +12 -0
  38. data/docs/BulkSendJobResponse.md +13 -0
  39. data/docs/BulkSendJobSendResponse.md +11 -0
  40. data/docs/EmbeddedApi.md +158 -0
  41. data/docs/EmbeddedEditUrlRequest.md +19 -0
  42. data/docs/EmbeddedEditUrlResponse.md +11 -0
  43. data/docs/EmbeddedEditUrlResponseEmbedded.md +11 -0
  44. data/docs/EmbeddedSignUrlResponse.md +11 -0
  45. data/docs/EmbeddedSignUrlResponseEmbedded.md +11 -0
  46. data/docs/ErrorResponse.md +10 -0
  47. data/docs/ErrorResponseError.md +12 -0
  48. data/docs/EventCallbackAccountRequest.md +10 -0
  49. data/docs/EventCallbackAccountRequestPayload.md +12 -0
  50. data/docs/EventCallbackApiAppRequest.md +10 -0
  51. data/docs/EventCallbackApiAppRequestPayload.md +13 -0
  52. data/docs/EventCallbackRequestEvent.md +13 -0
  53. data/docs/EventCallbackRequestEventMetadata.md +13 -0
  54. data/docs/FileResponse.md +11 -0
  55. data/docs/ListInfoResponse.md +13 -0
  56. data/docs/OAuthApi.md +158 -0
  57. data/docs/OAuthTokenGenerateRequest.md +14 -0
  58. data/docs/OAuthTokenRefreshRequest.md +11 -0
  59. data/docs/OAuthTokenResponse.md +14 -0
  60. data/docs/ReportApi.md +83 -0
  61. data/docs/ReportCreateRequest.md +12 -0
  62. data/docs/ReportCreateResponse.md +11 -0
  63. data/docs/ReportResponse.md +13 -0
  64. data/docs/SignatureRequestApi.md +1233 -0
  65. data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +22 -0
  66. data/docs/SignatureRequestBulkSendWithTemplateRequest.md +22 -0
  67. data/docs/SignatureRequestCreateEmbeddedRequest.md +31 -0
  68. data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +24 -0
  69. data/docs/SignatureRequestGetResponse.md +11 -0
  70. data/docs/SignatureRequestListResponse.md +12 -0
  71. data/docs/SignatureRequestRemindRequest.md +11 -0
  72. data/docs/SignatureRequestResponse.md +31 -0
  73. data/docs/SignatureRequestResponseAttachment.md +15 -0
  74. data/docs/SignatureRequestResponseCustomFieldBase.md +17 -0
  75. data/docs/SignatureRequestResponseCustomFieldCheckbox.md +11 -0
  76. data/docs/SignatureRequestResponseCustomFieldText.md +11 -0
  77. data/docs/SignatureRequestResponseCustomFieldTypeEnum.md +9 -0
  78. data/docs/SignatureRequestResponseData.md +14 -0
  79. data/docs/SignatureRequestResponseDataBase.md +14 -0
  80. data/docs/SignatureRequestResponseDataTypeEnum.md +9 -0
  81. data/docs/SignatureRequestResponseDataValueCheckbox.md +11 -0
  82. data/docs/SignatureRequestResponseDataValueCheckboxMerge.md +11 -0
  83. data/docs/SignatureRequestResponseDataValueDateSigned.md +11 -0
  84. data/docs/SignatureRequestResponseDataValueDropdown.md +11 -0
  85. data/docs/SignatureRequestResponseDataValueInitials.md +11 -0
  86. data/docs/SignatureRequestResponseDataValueRadio.md +11 -0
  87. data/docs/SignatureRequestResponseDataValueSignature.md +11 -0
  88. data/docs/SignatureRequestResponseDataValueText.md +11 -0
  89. data/docs/SignatureRequestResponseDataValueTextMerge.md +11 -0
  90. data/docs/SignatureRequestResponseSignatures.md +26 -0
  91. data/docs/SignatureRequestSendRequest.md +32 -0
  92. data/docs/SignatureRequestSendWithTemplateRequest.md +25 -0
  93. data/docs/SignatureRequestUpdateRequest.md +12 -0
  94. data/docs/SubAttachment.md +13 -0
  95. data/docs/SubBulkSignerList.md +11 -0
  96. data/docs/SubBulkSignerListCustomField.md +11 -0
  97. data/docs/SubCC.md +11 -0
  98. data/docs/SubCustomField.md +17 -0
  99. data/docs/SubEditorOptions.md +11 -0
  100. data/docs/SubFieldOptions.md +10 -0
  101. data/docs/SubFormFieldGroup.md +12 -0
  102. data/docs/SubFormFieldRule.md +13 -0
  103. data/docs/SubFormFieldRuleAction.md +13 -0
  104. data/docs/SubFormFieldRuleTrigger.md +13 -0
  105. data/docs/SubFormFieldsPerDocumentBase.md +33 -0
  106. data/docs/SubFormFieldsPerDocumentCheckbox.md +12 -0
  107. data/docs/SubFormFieldsPerDocumentCheckboxMerge.md +10 -0
  108. data/docs/SubFormFieldsPerDocumentDateSigned.md +10 -0
  109. data/docs/SubFormFieldsPerDocumentDropdown.md +12 -0
  110. data/docs/SubFormFieldsPerDocumentHyperlink.md +12 -0
  111. data/docs/SubFormFieldsPerDocumentInitials.md +10 -0
  112. data/docs/SubFormFieldsPerDocumentRadio.md +12 -0
  113. data/docs/SubFormFieldsPerDocumentSignature.md +10 -0
  114. data/docs/SubFormFieldsPerDocumentText.md +17 -0
  115. data/docs/SubFormFieldsPerDocumentTextMerge.md +10 -0
  116. data/docs/SubFormFieldsPerDocumentTypeEnum.md +9 -0
  117. data/docs/SubMergeField.md +11 -0
  118. data/docs/SubOAuth.md +11 -0
  119. data/docs/SubOptions.md +10 -0
  120. data/docs/SubSignatureRequestSigner.md +15 -0
  121. data/docs/SubSignatureRequestTemplateSigner.md +15 -0
  122. data/docs/SubSigningOptions.md +16 -0
  123. data/docs/SubTeamResponse.md +11 -0
  124. data/docs/SubTemplateRole.md +11 -0
  125. data/docs/SubUnclaimedDraftSigner.md +12 -0
  126. data/docs/SubUnclaimedDraftTemplateSigner.md +12 -0
  127. data/docs/SubWhiteLabelingOptions.md +26 -0
  128. data/docs/TeamAddMemberRequest.md +12 -0
  129. data/docs/TeamApi.md +664 -0
  130. data/docs/TeamCreateRequest.md +10 -0
  131. data/docs/TeamGetInfoResponse.md +11 -0
  132. data/docs/TeamGetResponse.md +11 -0
  133. data/docs/TeamInfoResponse.md +14 -0
  134. data/docs/TeamMemberResponse.md +12 -0
  135. data/docs/TeamMembersResponse.md +12 -0
  136. data/docs/TeamParentResponse.md +11 -0
  137. data/docs/TeamRemoveMemberRequest.md +14 -0
  138. data/docs/TeamResponse.md +12 -0
  139. data/docs/TeamSubTeamsResponse.md +12 -0
  140. data/docs/TeamUpdateRequest.md +10 -0
  141. data/docs/TemplateAddUserRequest.md +12 -0
  142. data/docs/TemplateApi.md +638 -0
  143. data/docs/TemplateCreateEmbeddedDraftRequest.md +34 -0
  144. data/docs/TemplateCreateEmbeddedDraftResponse.md +11 -0
  145. data/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +13 -0
  146. data/docs/TemplateEditResponse.md +10 -0
  147. data/docs/TemplateGetResponse.md +11 -0
  148. data/docs/TemplateListResponse.md +12 -0
  149. data/docs/TemplateRemoveUserRequest.md +11 -0
  150. data/docs/TemplateResponse.md +24 -0
  151. data/docs/TemplateResponseAccount.md +15 -0
  152. data/docs/TemplateResponseAccountQuota.md +13 -0
  153. data/docs/TemplateResponseCCRole.md +10 -0
  154. data/docs/TemplateResponseCustomField.md +22 -0
  155. data/docs/TemplateResponseDocument.md +15 -0
  156. data/docs/TemplateResponseDocumentCustomField.md +25 -0
  157. data/docs/TemplateResponseDocumentFieldGroup.md +11 -0
  158. data/docs/TemplateResponseDocumentFormField.md +23 -0
  159. data/docs/TemplateResponseDocumentStaticField.md +19 -0
  160. data/docs/TemplateResponseFieldAvgTextLength.md +11 -0
  161. data/docs/TemplateResponseNamedFormField.md +23 -0
  162. data/docs/TemplateResponseSignerRole.md +11 -0
  163. data/docs/TemplateUpdateFilesRequest.md +15 -0
  164. data/docs/TemplateUpdateFilesResponse.md +10 -0
  165. data/docs/TemplateUpdateFilesResponseTemplate.md +11 -0
  166. data/docs/UnclaimedDraftApi.md +359 -0
  167. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +44 -0
  168. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +38 -0
  169. data/docs/UnclaimedDraftCreateRequest.md +32 -0
  170. data/docs/UnclaimedDraftCreateResponse.md +11 -0
  171. data/docs/UnclaimedDraftEditAndResendRequest.md +17 -0
  172. data/docs/UnclaimedDraftResponse.md +15 -0
  173. data/docs/WarningResponse.md +11 -0
  174. data/{spec/fixtures/file.json → examples/.gitkeep} +0 -0
  175. data/examples/AccountCreate.rb +21 -0
  176. data/examples/AccountGet.rb +18 -0
  177. data/examples/AccountUpdate.rb +21 -0
  178. data/examples/AccountVerify.rb +21 -0
  179. data/examples/ApiAppCreate.rb +35 -0
  180. data/examples/ApiAppDelete.rb +20 -0
  181. data/examples/ApiAppGet.rb +20 -0
  182. data/examples/ApiAppList.rb +21 -0
  183. data/examples/ApiAppUpdate.rb +32 -0
  184. data/examples/BulkSendJobGet.rb +20 -0
  185. data/examples/BulkSendJobList.rb +21 -0
  186. data/examples/EmbeddedEditUrl.rb +24 -0
  187. data/examples/EmbeddedSignUrl.rb +20 -0
  188. data/examples/OauthTokenGenerate.rb +24 -0
  189. data/examples/OauthTokenRefresh.rb +21 -0
  190. data/examples/ReportCreate.rb +23 -0
  191. data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
  192. data/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
  193. data/examples/SignatureRequestCancel.rb +20 -0
  194. data/examples/SignatureRequestCreateEmbedded.rb +46 -0
  195. data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
  196. data/examples/SignatureRequestFiles.rb +20 -0
  197. data/examples/SignatureRequestGet.rb +20 -0
  198. data/examples/SignatureRequestList.rb +21 -0
  199. data/examples/SignatureRequestReleaseHold.rb +20 -0
  200. data/examples/SignatureRequestRemind.rb +23 -0
  201. data/examples/SignatureRequestRemove.rb +20 -0
  202. data/examples/SignatureRequestSend.rb +56 -0
  203. data/examples/SignatureRequestSendWithTemplate.rb +50 -0
  204. data/examples/SignatureRequestUpdate.rb +24 -0
  205. data/examples/TeamAddMember.rb +21 -0
  206. data/examples/TeamCreate.rb +21 -0
  207. data/examples/TeamDelete.rb +18 -0
  208. data/examples/TeamGet.rb +18 -0
  209. data/examples/TeamInfo.rb +18 -0
  210. data/examples/TeamMembers.rb +20 -0
  211. data/examples/TeamRemoveMember.rb +22 -0
  212. data/examples/TeamSubTeams.rb +20 -0
  213. data/examples/TeamUpdate.rb +21 -0
  214. data/examples/TemplateAddUser.rb +23 -0
  215. data/examples/TemplateCreateEmbeddedDraft.rb +49 -0
  216. data/examples/TemplateDelete.rb +20 -0
  217. data/examples/TemplateFiles.rb +20 -0
  218. data/examples/TemplateGet.rb +20 -0
  219. data/examples/TemplateList.rb +20 -0
  220. data/examples/TemplateRemoveUser.rb +23 -0
  221. data/examples/TemplateUpdateFiles.rb +23 -0
  222. data/examples/UnclaimedDraftCreate.rb +56 -0
  223. data/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
  224. data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
  225. data/examples/UnclaimedDraftEditAndResend.rb +24 -0
  226. data/hellosign-ruby-sdk.gemspec +37 -52
  227. data/lib/hellosign-ruby-sdk/api/account_api.rb +440 -0
  228. data/lib/hellosign-ruby-sdk/api/api_app_api.rb +501 -0
  229. data/lib/hellosign-ruby-sdk/api/bulk_send_job_api.rb +210 -0
  230. data/lib/hellosign-ruby-sdk/api/embedded_api.rb +231 -0
  231. data/lib/hellosign-ruby-sdk/api/o_auth_api.rb +212 -0
  232. data/lib/hellosign-ruby-sdk/api/report_api.rb +131 -0
  233. data/lib/hellosign-ruby-sdk/api/signature_request_api.rb +1435 -0
  234. data/lib/hellosign-ruby-sdk/api/team_api.rb +917 -0
  235. data/lib/hellosign-ruby-sdk/api/template_api.rb +852 -0
  236. data/lib/hellosign-ruby-sdk/api/unclaimed_draft_api.rb +464 -0
  237. data/lib/hellosign-ruby-sdk/api_client.rb +414 -0
  238. data/lib/hellosign-ruby-sdk/api_error.rb +57 -0
  239. data/lib/hellosign-ruby-sdk/configuration.rb +314 -0
  240. data/lib/hellosign-ruby-sdk/event_callback_helper.rb +32 -0
  241. data/lib/hellosign-ruby-sdk/models/account_create_request.rb +284 -0
  242. data/lib/hellosign-ruby-sdk/models/account_create_response.rb +269 -0
  243. data/lib/hellosign-ruby-sdk/models/account_get_response.rb +260 -0
  244. data/lib/hellosign-ruby-sdk/models/account_response.rb +331 -0
  245. data/lib/hellosign-ruby-sdk/models/account_response_quotas.rb +284 -0
  246. data/lib/hellosign-ruby-sdk/models/account_update_request.rb +270 -0
  247. data/lib/hellosign-ruby-sdk/models/account_verify_request.rb +254 -0
  248. data/lib/hellosign-ruby-sdk/models/account_verify_response.rb +260 -0
  249. data/lib/hellosign-ruby-sdk/models/account_verify_response_account.rb +249 -0
  250. data/lib/hellosign-ruby-sdk/models/api_app_create_request.rb +346 -0
  251. data/lib/hellosign-ruby-sdk/models/api_app_get_response.rb +260 -0
  252. data/lib/hellosign-ruby-sdk/models/api_app_list_response.rb +272 -0
  253. data/lib/hellosign-ruby-sdk/models/api_app_response.rb +341 -0
  254. data/lib/hellosign-ruby-sdk/models/api_app_response_o_auth.rb +282 -0
  255. data/lib/hellosign-ruby-sdk/models/api_app_response_options.rb +250 -0
  256. data/lib/hellosign-ruby-sdk/models/api_app_response_owner_account.rb +260 -0
  257. data/lib/hellosign-ruby-sdk/models/api_app_response_white_labeling_options.rb +366 -0
  258. data/lib/hellosign-ruby-sdk/models/api_app_update_request.rb +323 -0
  259. data/lib/hellosign-ruby-sdk/models/bulk_send_job_get_response.rb +281 -0
  260. data/lib/hellosign-ruby-sdk/models/bulk_send_job_get_response_signature_requests.rb +492 -0
  261. data/lib/hellosign-ruby-sdk/models/bulk_send_job_list_response.rb +272 -0
  262. data/lib/hellosign-ruby-sdk/models/bulk_send_job_response.rb +281 -0
  263. data/lib/hellosign-ruby-sdk/models/bulk_send_job_send_response.rb +260 -0
  264. data/lib/hellosign-ruby-sdk/models/embedded_edit_url_request.rb +356 -0
  265. data/lib/hellosign-ruby-sdk/models/embedded_edit_url_response.rb +260 -0
  266. data/lib/hellosign-ruby-sdk/models/embedded_edit_url_response_embedded.rb +260 -0
  267. data/lib/hellosign-ruby-sdk/models/embedded_sign_url_response.rb +260 -0
  268. data/lib/hellosign-ruby-sdk/models/embedded_sign_url_response_embedded.rb +260 -0
  269. data/lib/hellosign-ruby-sdk/models/error_response.rb +253 -0
  270. data/lib/hellosign-ruby-sdk/models/error_response_error.rb +280 -0
  271. data/lib/hellosign-ruby-sdk/models/event_callback_account_request.rb +253 -0
  272. data/lib/hellosign-ruby-sdk/models/event_callback_account_request_payload.rb +271 -0
  273. data/lib/hellosign-ruby-sdk/models/event_callback_api_app_request.rb +253 -0
  274. data/lib/hellosign-ruby-sdk/models/event_callback_api_app_request_payload.rb +280 -0
  275. data/lib/hellosign-ruby-sdk/models/event_callback_request_event.rb +333 -0
  276. data/lib/hellosign-ruby-sdk/models/event_callback_request_event_metadata.rb +284 -0
  277. data/lib/hellosign-ruby-sdk/models/file_response.rb +259 -0
  278. data/lib/hellosign-ruby-sdk/models/list_info_response.rb +281 -0
  279. data/lib/hellosign-ruby-sdk/models/o_auth_token_generate_request.rb +316 -0
  280. data/lib/hellosign-ruby-sdk/models/o_auth_token_refresh_request.rb +271 -0
  281. data/lib/hellosign-ruby-sdk/models/o_auth_token_response.rb +286 -0
  282. data/lib/hellosign-ruby-sdk/models/report_create_request.rb +318 -0
  283. data/lib/hellosign-ruby-sdk/models/report_create_response.rb +260 -0
  284. data/lib/hellosign-ruby-sdk/models/report_response.rb +304 -0
  285. data/lib/hellosign-ruby-sdk/models/signature_request_bulk_create_embedded_with_template_request.rb +445 -0
  286. data/lib/hellosign-ruby-sdk/models/signature_request_bulk_send_with_template_request.rb +439 -0
  287. data/lib/hellosign-ruby-sdk/models/signature_request_create_embedded_request.rb +551 -0
  288. data/lib/hellosign-ruby-sdk/models/signature_request_create_embedded_with_template_request.rb +475 -0
  289. data/lib/hellosign-ruby-sdk/models/signature_request_get_response.rb +260 -0
  290. data/lib/hellosign-ruby-sdk/models/signature_request_list_response.rb +272 -0
  291. data/lib/hellosign-ruby-sdk/models/signature_request_remind_request.rb +264 -0
  292. data/lib/hellosign-ruby-sdk/models/signature_request_response.rb +483 -0
  293. data/lib/hellosign-ruby-sdk/models/signature_request_response_attachment.rb +322 -0
  294. data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_base.rb +325 -0
  295. data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_checkbox.rb +271 -0
  296. data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_text.rb +271 -0
  297. data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_type_enum.rb +37 -0
  298. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_base.rb +335 -0
  299. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_type_enum.rb +44 -0
  300. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_checkbox.rb +265 -0
  301. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_checkbox_merge.rb +265 -0
  302. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_date_signed.rb +265 -0
  303. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_dropdown.rb +265 -0
  304. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_initials.rb +265 -0
  305. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_radio.rb +265 -0
  306. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_signature.rb +265 -0
  307. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_text.rb +265 -0
  308. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_text_merge.rb +265 -0
  309. data/lib/hellosign-ruby-sdk/models/signature_request_response_signatures.rb +423 -0
  310. data/lib/hellosign-ruby-sdk/models/signature_request_send_request.rb +555 -0
  311. data/lib/hellosign-ruby-sdk/models/signature_request_send_with_template_request.rb +479 -0
  312. data/lib/hellosign-ruby-sdk/models/signature_request_update_request.rb +274 -0
  313. data/lib/hellosign-ruby-sdk/models/sub_attachment.rb +291 -0
  314. data/lib/hellosign-ruby-sdk/models/sub_bulk_signer_list.rb +263 -0
  315. data/lib/hellosign-ruby-sdk/models/sub_bulk_signer_list_custom_field.rb +269 -0
  316. data/lib/hellosign-ruby-sdk/models/sub_cc.rb +269 -0
  317. data/lib/hellosign-ruby-sdk/models/sub_custom_field.rb +287 -0
  318. data/lib/hellosign-ruby-sdk/models/sub_editor_options.rb +264 -0
  319. data/lib/hellosign-ruby-sdk/models/sub_field_options.rb +289 -0
  320. data/lib/hellosign-ruby-sdk/models/sub_form_field_group.rb +284 -0
  321. data/lib/hellosign-ruby-sdk/models/sub_form_field_rule.rb +352 -0
  322. data/lib/hellosign-ruby-sdk/models/sub_form_field_rule_action.rb +322 -0
  323. data/lib/hellosign-ruby-sdk/models/sub_form_field_rule_trigger.rb +325 -0
  324. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_base.rb +444 -0
  325. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_checkbox.rb +286 -0
  326. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_checkbox_merge.rb +261 -0
  327. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_date_signed.rb +261 -0
  328. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_dropdown.rb +307 -0
  329. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_hyperlink.rb +291 -0
  330. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_initials.rb +261 -0
  331. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_radio.rb +291 -0
  332. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_signature.rb +261 -0
  333. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_text.rb +363 -0
  334. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_text_merge.rb +261 -0
  335. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_type_enum.rb +45 -0
  336. data/lib/hellosign-ruby-sdk/models/sub_merge_field.rb +303 -0
  337. data/lib/hellosign-ruby-sdk/models/sub_o_auth.rb +284 -0
  338. data/lib/hellosign-ruby-sdk/models/sub_options.rb +252 -0
  339. data/lib/hellosign-ruby-sdk/models/sub_signature_request_signer.rb +368 -0
  340. data/lib/hellosign-ruby-sdk/models/sub_signature_request_template_signer.rb +372 -0
  341. data/lib/hellosign-ruby-sdk/models/sub_signing_options.rb +337 -0
  342. data/lib/hellosign-ruby-sdk/models/sub_team_response.rb +259 -0
  343. data/lib/hellosign-ruby-sdk/models/sub_template_role.rb +260 -0
  344. data/lib/hellosign-ruby-sdk/models/sub_unclaimed_draft_signer.rb +280 -0
  345. data/lib/hellosign-ruby-sdk/models/sub_unclaimed_draft_template_signer.rb +284 -0
  346. data/lib/hellosign-ruby-sdk/models/sub_white_labeling_options.rb +438 -0
  347. data/lib/hellosign-ruby-sdk/models/team_add_member_request.rb +303 -0
  348. data/lib/hellosign-ruby-sdk/models/team_create_request.rb +251 -0
  349. data/lib/hellosign-ruby-sdk/models/team_get_info_response.rb +260 -0
  350. data/lib/hellosign-ruby-sdk/models/team_get_response.rb +260 -0
  351. data/lib/hellosign-ruby-sdk/models/team_info_response.rb +289 -0
  352. data/lib/hellosign-ruby-sdk/models/team_member_response.rb +269 -0
  353. data/lib/hellosign-ruby-sdk/models/team_members_response.rb +271 -0
  354. data/lib/hellosign-ruby-sdk/models/team_parent_response.rb +260 -0
  355. data/lib/hellosign-ruby-sdk/models/team_remove_member_request.rb +323 -0
  356. data/lib/hellosign-ruby-sdk/models/team_response.rb +273 -0
  357. data/lib/hellosign-ruby-sdk/models/team_sub_teams_response.rb +271 -0
  358. data/lib/hellosign-ruby-sdk/models/team_update_request.rb +249 -0
  359. data/lib/hellosign-ruby-sdk/models/template_add_user_request.rb +271 -0
  360. data/lib/hellosign-ruby-sdk/models/template_create_embedded_draft_request.rb +566 -0
  361. data/lib/hellosign-ruby-sdk/models/template_create_embedded_draft_response.rb +260 -0
  362. data/lib/hellosign-ruby-sdk/models/template_create_embedded_draft_response_template.rb +282 -0
  363. data/lib/hellosign-ruby-sdk/models/template_edit_response.rb +249 -0
  364. data/lib/hellosign-ruby-sdk/models/template_get_response.rb +260 -0
  365. data/lib/hellosign-ruby-sdk/models/template_list_response.rb +272 -0
  366. data/lib/hellosign-ruby-sdk/models/template_remove_user_request.rb +259 -0
  367. data/lib/hellosign-ruby-sdk/models/template_response.rb +409 -0
  368. data/lib/hellosign-ruby-sdk/models/template_response_account.rb +298 -0
  369. data/lib/hellosign-ruby-sdk/models/template_response_account_quota.rb +280 -0
  370. data/lib/hellosign-ruby-sdk/models/template_response_cc_role.rb +249 -0
  371. data/lib/hellosign-ruby-sdk/models/template_response_custom_field.rb +406 -0
  372. data/lib/hellosign-ruby-sdk/models/template_response_document.rb +308 -0
  373. data/lib/hellosign-ruby-sdk/models/template_response_document_custom_field.rb +437 -0
  374. data/lib/hellosign-ruby-sdk/models/template_response_document_field_group.rb +259 -0
  375. data/lib/hellosign-ruby-sdk/models/template_response_document_form_field.rb +416 -0
  376. data/lib/hellosign-ruby-sdk/models/template_response_document_static_field.rb +340 -0
  377. data/lib/hellosign-ruby-sdk/models/template_response_field_avg_text_length.rb +260 -0
  378. data/lib/hellosign-ruby-sdk/models/template_response_named_form_field.rb +382 -0
  379. data/lib/hellosign-ruby-sdk/models/template_response_signer_role.rb +259 -0
  380. data/lib/hellosign-ruby-sdk/models/template_update_files_request.rb +335 -0
  381. data/lib/hellosign-ruby-sdk/models/template_update_files_response.rb +248 -0
  382. data/lib/hellosign-ruby-sdk/models/template_update_files_response_template.rb +262 -0
  383. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_embedded_request.rb +716 -0
  384. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_embedded_with_template_request.rb +630 -0
  385. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_request.rb +574 -0
  386. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_response.rb +260 -0
  387. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_edit_and_resend_request.rb +327 -0
  388. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_response.rb +304 -0
  389. data/lib/hellosign-ruby-sdk/models/warning_response.rb +270 -0
  390. data/lib/hellosign-ruby-sdk/version.rb +15 -0
  391. data/lib/hellosign-ruby-sdk.rb +199 -3
  392. data/oas/.editorconfig +6 -0
  393. data/oas/.git +1 -0
  394. data/oas/.github/workflows/github-actions.yml +79 -0
  395. data/oas/.gitignore +2 -0
  396. data/oas/.redocly.lint-ignore.yaml +5 -0
  397. data/oas/.redocly.yaml +11 -0
  398. data/oas/LICENSE +68 -0
  399. data/oas/README.md +107 -0
  400. data/oas/bin/generate-sdk-oas.php +75 -0
  401. data/oas/bin/generate-translated-oas.php +144 -0
  402. data/oas/bin/php +15 -0
  403. data/oas/bin/plugins/decorators/check-for-beta-features.js +68 -0
  404. data/oas/bin/plugins/set-beta-plugin.js +14 -0
  405. data/oas/bin/redoc +17 -0
  406. data/oas/bin/validate +14 -0
  407. data/oas/build +23 -0
  408. data/oas/composer.json +15 -0
  409. data/oas/composer.lock +246 -0
  410. data/oas/examples/AccountCreate.cs +36 -0
  411. data/oas/examples/AccountCreate.java +42 -0
  412. data/oas/examples/AccountCreate.js +21 -0
  413. data/oas/examples/AccountCreate.php +25 -0
  414. data/oas/examples/AccountCreate.py +25 -0
  415. data/oas/examples/AccountCreate.rb +21 -0
  416. data/oas/examples/AccountCreate.ts +21 -0
  417. data/oas/examples/AccountGet.cs +32 -0
  418. data/oas/examples/AccountGet.java +39 -0
  419. data/oas/examples/AccountGet.js +17 -0
  420. data/oas/examples/AccountGet.php +22 -0
  421. data/oas/examples/AccountGet.py +21 -0
  422. data/oas/examples/AccountGet.rb +18 -0
  423. data/oas/examples/AccountGet.ts +17 -0
  424. data/oas/examples/AccountUpdate.cs +36 -0
  425. data/oas/examples/AccountUpdate.java +42 -0
  426. data/oas/examples/AccountUpdate.js +21 -0
  427. data/oas/examples/AccountUpdate.php +25 -0
  428. data/oas/examples/AccountUpdate.py +25 -0
  429. data/oas/examples/AccountUpdate.rb +21 -0
  430. data/oas/examples/AccountUpdate.ts +21 -0
  431. data/oas/examples/AccountVerify.cs +36 -0
  432. data/oas/examples/AccountVerify.java +42 -0
  433. data/oas/examples/AccountVerify.js +21 -0
  434. data/oas/examples/AccountVerify.php +25 -0
  435. data/oas/examples/AccountVerify.py +25 -0
  436. data/oas/examples/AccountVerify.rb +21 -0
  437. data/oas/examples/AccountVerify.ts +21 -0
  438. data/oas/examples/ApiAppCreate.cs +59 -0
  439. data/oas/examples/ApiAppCreate.java +61 -0
  440. data/oas/examples/ApiAppCreate.js +38 -0
  441. data/oas/examples/ApiAppCreate.php +42 -0
  442. data/oas/examples/ApiAppCreate.py +41 -0
  443. data/oas/examples/ApiAppCreate.rb +35 -0
  444. data/oas/examples/ApiAppCreate.ts +38 -0
  445. data/oas/examples/ApiAppDelete.cs +34 -0
  446. data/oas/examples/ApiAppDelete.java +40 -0
  447. data/oas/examples/ApiAppDelete.js +19 -0
  448. data/oas/examples/ApiAppDelete.php +23 -0
  449. data/oas/examples/ApiAppDelete.py +23 -0
  450. data/oas/examples/ApiAppDelete.rb +20 -0
  451. data/oas/examples/ApiAppDelete.ts +19 -0
  452. data/oas/examples/ApiAppGet.cs +34 -0
  453. data/oas/examples/ApiAppGet.java +41 -0
  454. data/oas/examples/ApiAppGet.js +19 -0
  455. data/oas/examples/ApiAppGet.php +24 -0
  456. data/oas/examples/ApiAppGet.py +23 -0
  457. data/oas/examples/ApiAppGet.rb +20 -0
  458. data/oas/examples/ApiAppGet.ts +19 -0
  459. data/oas/examples/ApiAppList.cs +35 -0
  460. data/oas/examples/ApiAppList.java +42 -0
  461. data/oas/examples/ApiAppList.js +20 -0
  462. data/oas/examples/ApiAppList.php +25 -0
  463. data/oas/examples/ApiAppList.py +27 -0
  464. data/oas/examples/ApiAppList.rb +21 -0
  465. data/oas/examples/ApiAppList.ts +20 -0
  466. data/oas/examples/ApiAppUpdate.cs +61 -0
  467. data/oas/examples/ApiAppUpdate.java +63 -0
  468. data/oas/examples/ApiAppUpdate.js +31 -0
  469. data/oas/examples/ApiAppUpdate.php +36 -0
  470. data/oas/examples/ApiAppUpdate.py +37 -0
  471. data/oas/examples/ApiAppUpdate.rb +32 -0
  472. data/oas/examples/ApiAppUpdate.ts +31 -0
  473. data/oas/examples/BulkSendJobGet.cs +35 -0
  474. data/oas/examples/BulkSendJobGet.java +41 -0
  475. data/oas/examples/BulkSendJobGet.js +19 -0
  476. data/oas/examples/BulkSendJobGet.php +24 -0
  477. data/oas/examples/BulkSendJobGet.py +23 -0
  478. data/oas/examples/BulkSendJobGet.rb +20 -0
  479. data/oas/examples/BulkSendJobGet.ts +19 -0
  480. data/oas/examples/BulkSendJobList.cs +36 -0
  481. data/oas/examples/BulkSendJobList.java +42 -0
  482. data/oas/examples/BulkSendJobList.js +20 -0
  483. data/oas/examples/BulkSendJobList.php +25 -0
  484. data/oas/examples/BulkSendJobList.py +27 -0
  485. data/oas/examples/BulkSendJobList.rb +21 -0
  486. data/oas/examples/BulkSendJobList.ts +20 -0
  487. data/oas/examples/EmbeddedEditUrl.cs +40 -0
  488. data/oas/examples/EmbeddedEditUrl.java +47 -0
  489. data/oas/examples/EmbeddedEditUrl.js +24 -0
  490. data/oas/examples/EmbeddedEditUrl.php +28 -0
  491. data/oas/examples/EmbeddedEditUrl.py +28 -0
  492. data/oas/examples/EmbeddedEditUrl.rb +24 -0
  493. data/oas/examples/EmbeddedEditUrl.ts +24 -0
  494. data/oas/examples/EmbeddedSignUrl.cs +35 -0
  495. data/oas/examples/EmbeddedSignUrl.java +44 -0
  496. data/oas/examples/EmbeddedSignUrl.js +19 -0
  497. data/oas/examples/EmbeddedSignUrl.php +24 -0
  498. data/oas/examples/EmbeddedSignUrl.py +23 -0
  499. data/oas/examples/EmbeddedSignUrl.rb +20 -0
  500. data/oas/examples/EmbeddedSignUrl.ts +19 -0
  501. data/oas/examples/OauthTokenGenerate.cs +40 -0
  502. data/oas/examples/OauthTokenGenerate.java +45 -0
  503. data/oas/examples/OauthTokenGenerate.js +23 -0
  504. data/oas/examples/OauthTokenGenerate.php +22 -0
  505. data/oas/examples/OauthTokenGenerate.py +28 -0
  506. data/oas/examples/OauthTokenGenerate.rb +24 -0
  507. data/oas/examples/OauthTokenGenerate.ts +23 -0
  508. data/oas/examples/OauthTokenRefresh.cs +37 -0
  509. data/oas/examples/OauthTokenRefresh.java +42 -0
  510. data/oas/examples/OauthTokenRefresh.js +20 -0
  511. data/oas/examples/OauthTokenRefresh.php +19 -0
  512. data/oas/examples/OauthTokenRefresh.py +25 -0
  513. data/oas/examples/OauthTokenRefresh.rb +21 -0
  514. data/oas/examples/OauthTokenRefresh.ts +20 -0
  515. data/oas/examples/ReportCreate.cs +42 -0
  516. data/oas/examples/ReportCreate.java +47 -0
  517. data/oas/examples/ReportCreate.js +23 -0
  518. data/oas/examples/ReportCreate.php +27 -0
  519. data/oas/examples/ReportCreate.py +27 -0
  520. data/oas/examples/ReportCreate.rb +23 -0
  521. data/oas/examples/ReportCreate.ts +23 -0
  522. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs +82 -0
  523. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java +81 -0
  524. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js +63 -0
  525. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php +60 -0
  526. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py +70 -0
  527. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
  528. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts +63 -0
  529. data/oas/examples/SignatureRequestBulkSendWithTemplate.cs +81 -0
  530. data/oas/examples/SignatureRequestBulkSendWithTemplate.java +81 -0
  531. data/oas/examples/SignatureRequestBulkSendWithTemplate.js +65 -0
  532. data/oas/examples/SignatureRequestBulkSendWithTemplate.php +62 -0
  533. data/oas/examples/SignatureRequestBulkSendWithTemplate.py +69 -0
  534. data/oas/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
  535. data/oas/examples/SignatureRequestBulkSendWithTemplate.ts +65 -0
  536. data/oas/examples/SignatureRequestCancel.cs +34 -0
  537. data/oas/examples/SignatureRequestCancel.java +42 -0
  538. data/oas/examples/SignatureRequestCancel.js +19 -0
  539. data/oas/examples/SignatureRequestCancel.php +23 -0
  540. data/oas/examples/SignatureRequestCancel.py +23 -0
  541. data/oas/examples/SignatureRequestCancel.rb +20 -0
  542. data/oas/examples/SignatureRequestCancel.ts +19 -0
  543. data/oas/examples/SignatureRequestCreateEmbedded.cs +64 -0
  544. data/oas/examples/SignatureRequestCreateEmbedded.java +69 -0
  545. data/oas/examples/SignatureRequestCreateEmbedded.js +52 -0
  546. data/oas/examples/SignatureRequestCreateEmbedded.php +53 -0
  547. data/oas/examples/SignatureRequestCreateEmbedded.py +53 -0
  548. data/oas/examples/SignatureRequestCreateEmbedded.rb +46 -0
  549. data/oas/examples/SignatureRequestCreateEmbedded.ts +52 -0
  550. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.cs +55 -0
  551. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.java +51 -0
  552. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.js +41 -0
  553. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.php +43 -0
  554. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.py +45 -0
  555. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
  556. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.ts +41 -0
  557. data/oas/examples/SignatureRequestFiles.cs +34 -0
  558. data/oas/examples/SignatureRequestFiles.java +41 -0
  559. data/oas/examples/SignatureRequestFiles.js +19 -0
  560. data/oas/examples/SignatureRequestFiles.php +24 -0
  561. data/oas/examples/SignatureRequestFiles.py +23 -0
  562. data/oas/examples/SignatureRequestFiles.rb +20 -0
  563. data/oas/examples/SignatureRequestFiles.ts +19 -0
  564. data/oas/examples/SignatureRequestGet.cs +34 -0
  565. data/oas/examples/SignatureRequestGet.java +41 -0
  566. data/oas/examples/SignatureRequestGet.js +19 -0
  567. data/oas/examples/SignatureRequestGet.php +24 -0
  568. data/oas/examples/SignatureRequestGet.py +23 -0
  569. data/oas/examples/SignatureRequestGet.rb +20 -0
  570. data/oas/examples/SignatureRequestGet.ts +19 -0
  571. data/oas/examples/SignatureRequestList.cs +34 -0
  572. data/oas/examples/SignatureRequestList.java +41 -0
  573. data/oas/examples/SignatureRequestList.js +20 -0
  574. data/oas/examples/SignatureRequestList.php +25 -0
  575. data/oas/examples/SignatureRequestList.py +27 -0
  576. data/oas/examples/SignatureRequestList.rb +21 -0
  577. data/oas/examples/SignatureRequestList.ts +20 -0
  578. data/oas/examples/SignatureRequestReleaseHold.cs +34 -0
  579. data/oas/examples/SignatureRequestReleaseHold.java +40 -0
  580. data/oas/examples/SignatureRequestReleaseHold.js +19 -0
  581. data/oas/examples/SignatureRequestReleaseHold.php +24 -0
  582. data/oas/examples/SignatureRequestReleaseHold.py +23 -0
  583. data/oas/examples/SignatureRequestReleaseHold.rb +20 -0
  584. data/oas/examples/SignatureRequestReleaseHold.ts +19 -0
  585. data/oas/examples/SignatureRequestRemind.cs +38 -0
  586. data/oas/examples/SignatureRequestRemind.java +43 -0
  587. data/oas/examples/SignatureRequestRemind.js +23 -0
  588. data/oas/examples/SignatureRequestRemind.php +27 -0
  589. data/oas/examples/SignatureRequestRemind.py +27 -0
  590. data/oas/examples/SignatureRequestRemind.rb +23 -0
  591. data/oas/examples/SignatureRequestRemind.ts +23 -0
  592. data/oas/examples/SignatureRequestRemove.cs +33 -0
  593. data/oas/examples/SignatureRequestRemove.java +39 -0
  594. data/oas/examples/SignatureRequestRemove.js +19 -0
  595. data/oas/examples/SignatureRequestRemove.php +20 -0
  596. data/oas/examples/SignatureRequestRemove.py +23 -0
  597. data/oas/examples/SignatureRequestRemove.rb +20 -0
  598. data/oas/examples/SignatureRequestRemove.ts +19 -0
  599. data/oas/examples/SignatureRequestSend.cs +75 -0
  600. data/oas/examples/SignatureRequestSend.java +75 -0
  601. data/oas/examples/SignatureRequestSend.js +60 -0
  602. data/oas/examples/SignatureRequestSend.php +60 -0
  603. data/oas/examples/SignatureRequestSend.py +64 -0
  604. data/oas/examples/SignatureRequestSend.rb +56 -0
  605. data/oas/examples/SignatureRequestSend.ts +60 -0
  606. data/oas/examples/SignatureRequestSendWithTemplate.cs +69 -0
  607. data/oas/examples/SignatureRequestSendWithTemplate.java +75 -0
  608. data/oas/examples/SignatureRequestSendWithTemplate.js +54 -0
  609. data/oas/examples/SignatureRequestSendWithTemplate.php +54 -0
  610. data/oas/examples/SignatureRequestSendWithTemplate.py +58 -0
  611. data/oas/examples/SignatureRequestSendWithTemplate.rb +50 -0
  612. data/oas/examples/SignatureRequestSendWithTemplate.ts +54 -0
  613. data/oas/examples/SignatureRequestUpdate.cs +39 -0
  614. data/oas/examples/SignatureRequestUpdate.java +44 -0
  615. data/oas/examples/SignatureRequestUpdate.js +24 -0
  616. data/oas/examples/SignatureRequestUpdate.php +28 -0
  617. data/oas/examples/SignatureRequestUpdate.py +28 -0
  618. data/oas/examples/SignatureRequestUpdate.rb +24 -0
  619. data/oas/examples/SignatureRequestUpdate.ts +24 -0
  620. data/oas/examples/TeamAddMember.cs +36 -0
  621. data/oas/examples/TeamAddMember.java +41 -0
  622. data/oas/examples/TeamAddMember.js +21 -0
  623. data/oas/examples/TeamAddMember.php +25 -0
  624. data/oas/examples/TeamAddMember.py +25 -0
  625. data/oas/examples/TeamAddMember.rb +21 -0
  626. data/oas/examples/TeamAddMember.ts +21 -0
  627. data/oas/examples/TeamCreate.cs +36 -0
  628. data/oas/examples/TeamCreate.java +41 -0
  629. data/oas/examples/TeamCreate.js +21 -0
  630. data/oas/examples/TeamCreate.php +25 -0
  631. data/oas/examples/TeamCreate.py +25 -0
  632. data/oas/examples/TeamCreate.rb +21 -0
  633. data/oas/examples/TeamCreate.ts +21 -0
  634. data/oas/examples/TeamDelete.cs +31 -0
  635. data/oas/examples/TeamDelete.java +37 -0
  636. data/oas/examples/TeamDelete.js +17 -0
  637. data/oas/examples/TeamDelete.php +21 -0
  638. data/oas/examples/TeamDelete.py +21 -0
  639. data/oas/examples/TeamDelete.rb +18 -0
  640. data/oas/examples/TeamDelete.ts +17 -0
  641. data/oas/examples/TeamGet.cs +32 -0
  642. data/oas/examples/TeamGet.java +38 -0
  643. data/oas/examples/TeamGet.js +17 -0
  644. data/oas/examples/TeamGet.php +22 -0
  645. data/oas/examples/TeamGet.py +21 -0
  646. data/oas/examples/TeamGet.rb +18 -0
  647. data/oas/examples/TeamGet.ts +17 -0
  648. data/oas/examples/TeamInfo.cs +32 -0
  649. data/oas/examples/TeamInfo.java +38 -0
  650. data/oas/examples/TeamInfo.js +17 -0
  651. data/oas/examples/TeamInfo.php +22 -0
  652. data/oas/examples/TeamInfo.py +21 -0
  653. data/oas/examples/TeamInfo.rb +18 -0
  654. data/oas/examples/TeamInfo.ts +17 -0
  655. data/oas/examples/TeamMembers.cs +33 -0
  656. data/oas/examples/TeamMembers.java +40 -0
  657. data/oas/examples/TeamMembers.js +19 -0
  658. data/oas/examples/TeamMembers.php +24 -0
  659. data/oas/examples/TeamMembers.py +23 -0
  660. data/oas/examples/TeamMembers.rb +20 -0
  661. data/oas/examples/TeamMembers.ts +19 -0
  662. data/oas/examples/TeamRemoveMember.cs +37 -0
  663. data/oas/examples/TeamRemoveMember.java +42 -0
  664. data/oas/examples/TeamRemoveMember.js +22 -0
  665. data/oas/examples/TeamRemoveMember.php +26 -0
  666. data/oas/examples/TeamRemoveMember.py +26 -0
  667. data/oas/examples/TeamRemoveMember.rb +22 -0
  668. data/oas/examples/TeamRemoveMember.ts +22 -0
  669. data/oas/examples/TeamSubTeams.cs +33 -0
  670. data/oas/examples/TeamSubTeams.java +40 -0
  671. data/oas/examples/TeamSubTeams.js +19 -0
  672. data/oas/examples/TeamSubTeams.php +24 -0
  673. data/oas/examples/TeamSubTeams.py +23 -0
  674. data/oas/examples/TeamSubTeams.rb +20 -0
  675. data/oas/examples/TeamSubTeams.ts +19 -0
  676. data/oas/examples/TeamUpdate.cs +36 -0
  677. data/oas/examples/TeamUpdate.java +40 -0
  678. data/oas/examples/TeamUpdate.js +21 -0
  679. data/oas/examples/TeamUpdate.php +25 -0
  680. data/oas/examples/TeamUpdate.py +25 -0
  681. data/oas/examples/TeamUpdate.rb +21 -0
  682. data/oas/examples/TeamUpdate.ts +21 -0
  683. data/oas/examples/TemplateAddUser.cs +38 -0
  684. data/oas/examples/TemplateAddUser.java +42 -0
  685. data/oas/examples/TemplateAddUser.js +23 -0
  686. data/oas/examples/TemplateAddUser.php +27 -0
  687. data/oas/examples/TemplateAddUser.py +27 -0
  688. data/oas/examples/TemplateAddUser.rb +23 -0
  689. data/oas/examples/TemplateAddUser.ts +23 -0
  690. data/oas/examples/TemplateCreateEmbeddedDraft.cs +69 -0
  691. data/oas/examples/TemplateCreateEmbeddedDraft.java +70 -0
  692. data/oas/examples/TemplateCreateEmbeddedDraft.js +60 -0
  693. data/oas/examples/TemplateCreateEmbeddedDraft.php +53 -0
  694. data/oas/examples/TemplateCreateEmbeddedDraft.py +58 -0
  695. data/oas/examples/TemplateCreateEmbeddedDraft.rb +49 -0
  696. data/oas/examples/TemplateCreateEmbeddedDraft.ts +60 -0
  697. data/oas/examples/TemplateDelete.cs +33 -0
  698. data/oas/examples/TemplateDelete.java +39 -0
  699. data/oas/examples/TemplateDelete.js +19 -0
  700. data/oas/examples/TemplateDelete.php +23 -0
  701. data/oas/examples/TemplateDelete.py +23 -0
  702. data/oas/examples/TemplateDelete.rb +20 -0
  703. data/oas/examples/TemplateDelete.ts +19 -0
  704. data/oas/examples/TemplateFiles.cs +34 -0
  705. data/oas/examples/TemplateFiles.java +40 -0
  706. data/oas/examples/TemplateFiles.js +19 -0
  707. data/oas/examples/TemplateFiles.php +24 -0
  708. data/oas/examples/TemplateFiles.py +23 -0
  709. data/oas/examples/TemplateFiles.rb +20 -0
  710. data/oas/examples/TemplateFiles.ts +19 -0
  711. data/oas/examples/TemplateGet.cs +34 -0
  712. data/oas/examples/TemplateGet.java +40 -0
  713. data/oas/examples/TemplateGet.js +19 -0
  714. data/oas/examples/TemplateGet.php +24 -0
  715. data/oas/examples/TemplateGet.py +23 -0
  716. data/oas/examples/TemplateGet.rb +20 -0
  717. data/oas/examples/TemplateGet.ts +19 -0
  718. data/oas/examples/TemplateList.cs +34 -0
  719. data/oas/examples/TemplateList.java +40 -0
  720. data/oas/examples/TemplateList.js +19 -0
  721. data/oas/examples/TemplateList.php +24 -0
  722. data/oas/examples/TemplateList.py +25 -0
  723. data/oas/examples/TemplateList.rb +20 -0
  724. data/oas/examples/TemplateList.ts +19 -0
  725. data/oas/examples/TemplateRemoveUser.cs +38 -0
  726. data/oas/examples/TemplateRemoveUser.java +43 -0
  727. data/oas/examples/TemplateRemoveUser.js +23 -0
  728. data/oas/examples/TemplateRemoveUser.php +27 -0
  729. data/oas/examples/TemplateRemoveUser.py +27 -0
  730. data/oas/examples/TemplateRemoveUser.rb +23 -0
  731. data/oas/examples/TemplateRemoveUser.ts +23 -0
  732. data/oas/examples/TemplateUpdateFiles.cs +38 -0
  733. data/oas/examples/TemplateUpdateFiles.java +44 -0
  734. data/oas/examples/TemplateUpdateFiles.js +23 -0
  735. data/oas/examples/TemplateUpdateFiles.php +27 -0
  736. data/oas/examples/TemplateUpdateFiles.py +27 -0
  737. data/oas/examples/TemplateUpdateFiles.rb +23 -0
  738. data/oas/examples/TemplateUpdateFiles.ts +23 -0
  739. data/oas/examples/UnclaimedDraftCreate.cs +75 -0
  740. data/oas/examples/UnclaimedDraftCreate.java +73 -0
  741. data/oas/examples/UnclaimedDraftCreate.js +63 -0
  742. data/oas/examples/UnclaimedDraftCreate.php +60 -0
  743. data/oas/examples/UnclaimedDraftCreate.py +64 -0
  744. data/oas/examples/UnclaimedDraftCreate.rb +56 -0
  745. data/oas/examples/UnclaimedDraftCreate.ts +63 -0
  746. data/oas/examples/UnclaimedDraftCreateEmbedded.cs +39 -0
  747. data/oas/examples/UnclaimedDraftCreateEmbedded.java +46 -0
  748. data/oas/examples/UnclaimedDraftCreateEmbedded.js +24 -0
  749. data/oas/examples/UnclaimedDraftCreateEmbedded.php +28 -0
  750. data/oas/examples/UnclaimedDraftCreateEmbedded.py +28 -0
  751. data/oas/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
  752. data/oas/examples/UnclaimedDraftCreateEmbedded.ts +24 -0
  753. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs +52 -0
  754. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java +58 -0
  755. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.js +37 -0
  756. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.php +39 -0
  757. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py +41 -0
  758. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
  759. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts +37 -0
  760. data/oas/examples/UnclaimedDraftEditAndResend.cs +39 -0
  761. data/oas/examples/UnclaimedDraftEditAndResend.java +44 -0
  762. data/oas/examples/UnclaimedDraftEditAndResend.js +24 -0
  763. data/oas/examples/UnclaimedDraftEditAndResend.php +28 -0
  764. data/oas/examples/UnclaimedDraftEditAndResend.py +28 -0
  765. data/oas/examples/UnclaimedDraftEditAndResend.rb +24 -0
  766. data/oas/examples/UnclaimedDraftEditAndResend.ts +24 -0
  767. data/oas/examples/json/AccountCreateOAuthResponseExample.json +14 -0
  768. data/oas/examples/json/AccountCreateRequestDefaultExample.json +3 -0
  769. data/oas/examples/json/AccountCreateRequestOAuthExample.json +5 -0
  770. data/oas/examples/json/AccountCreateResponseExample.json +18 -0
  771. data/oas/examples/json/AccountGetResponseExample.json +18 -0
  772. data/oas/examples/json/AccountUpdateRequestDefaultExample.json +4 -0
  773. data/oas/examples/json/AccountUpdateResponseExample.json +18 -0
  774. data/oas/examples/json/AccountVerifyFoundResponseExample.json +5 -0
  775. data/oas/examples/json/AccountVerifyNotFoundResponseExample.json +1 -0
  776. data/oas/examples/json/AccountVerifyRequestDefaultExample.json +3 -0
  777. data/oas/examples/json/ApiAppCreateRequestDefaultExample.json +17 -0
  778. data/oas/examples/json/ApiAppCreateRequestFormDataExample.json +18 -0
  779. data/oas/examples/json/ApiAppCreateResponseExample.json +26 -0
  780. data/oas/examples/json/ApiAppGetResponseExample.json +22 -0
  781. data/oas/examples/json/ApiAppListResponseExample.json +43 -0
  782. data/oas/examples/json/ApiAppUpdateRequestDefaultExample.json +8 -0
  783. data/oas/examples/json/ApiAppUpdateRequestFormDataExample.json +9 -0
  784. data/oas/examples/json/ApiAppUpdateResponseExample.json +26 -0
  785. data/oas/examples/json/BulkSendJobGetResponseExample.json +69 -0
  786. data/oas/examples/json/BulkSendJobListResponseExample.json +22 -0
  787. data/oas/examples/json/EmbeddedEditUrlRequestDefaultExample.json +6 -0
  788. data/oas/examples/json/EmbeddedEditUrlResponseExample.json +6 -0
  789. data/oas/examples/json/EmbeddedSignUrlResponseExample.json +6 -0
  790. data/oas/examples/json/Error400ResponseExample.json +7 -0
  791. data/oas/examples/json/Error401ResponseExample.json +6 -0
  792. data/oas/examples/json/Error402ResponseExample.json +6 -0
  793. data/oas/examples/json/Error403ResponseExample.json +6 -0
  794. data/oas/examples/json/Error404ResponseExample.json +6 -0
  795. data/oas/examples/json/Error409ResponseExample.json +6 -0
  796. data/oas/examples/json/Error410ResponseExample.json +6 -0
  797. data/oas/examples/json/Error422ResponseExample.json +6 -0
  798. data/oas/examples/json/Error429ResponseExample.json +6 -0
  799. data/oas/examples/json/Error4XXResponseExample.json +7 -0
  800. data/oas/examples/json/EventCallbackAccountSignatureRequestSentExample.json +51 -0
  801. data/oas/examples/json/EventCallbackAccountTemplateCreatedExample.json +140 -0
  802. data/oas/examples/json/EventCallbackApiAppAccountConfirmedExample.json +28 -0
  803. data/oas/examples/json/EventCallbackApiAppSignatureRequestSentExample.json +51 -0
  804. data/oas/examples/json/EventCallbackApiAppTemplateCreatedExample.json +140 -0
  805. data/oas/examples/json/OAuthTokenGenerateRequestExample.json +7 -0
  806. data/oas/examples/json/OAuthTokenGenerateResponseExample.json +7 -0
  807. data/oas/examples/json/OAuthTokenRefreshRequestExample.json +4 -0
  808. data/oas/examples/json/OAuthTokenRefreshResponseExample.json +6 -0
  809. data/oas/examples/json/ReportCreateRequestDefaultExample.json +8 -0
  810. data/oas/examples/json/ReportCreateResponseExample.json +11 -0
  811. data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json +49 -0
  812. data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json +16 -0
  813. data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json +8 -0
  814. data/oas/examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json +48 -0
  815. data/oas/examples/json/SignatureRequestBulkSendWithTemplateRequestFormDataExample.json +15 -0
  816. data/oas/examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json +8 -0
  817. data/oas/examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json +33 -0
  818. data/oas/examples/json/SignatureRequestCreateEmbeddedRequestFormDataExample.json +34 -0
  819. data/oas/examples/json/SignatureRequestCreateEmbeddedResponseExample.json +52 -0
  820. data/oas/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json +23 -0
  821. data/oas/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestFormDataExample.json +27 -0
  822. data/oas/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json +45 -0
  823. data/oas/examples/json/SignatureRequestFilesResponseExample.json +4 -0
  824. data/oas/examples/json/SignatureRequestGetResponseExample.json +58 -0
  825. data/oas/examples/json/SignatureRequestListResponseExample.json +112 -0
  826. data/oas/examples/json/SignatureRequestReleaseHoldResponseExample.json +32 -0
  827. data/oas/examples/json/SignatureRequestRemindRequestDefaultExample.json +3 -0
  828. data/oas/examples/json/SignatureRequestRemindResponseExample.json +35 -0
  829. data/oas/examples/json/SignatureRequestSendFormDataExample.json +40 -0
  830. data/oas/examples/json/SignatureRequestSendRequestDefaultExample.json +39 -0
  831. data/oas/examples/json/SignatureRequestSendResponseExample.json +76 -0
  832. data/oas/examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json +36 -0
  833. data/oas/examples/json/SignatureRequestSendWithTemplateRequestFormDataExample.json +40 -0
  834. data/oas/examples/json/SignatureRequestSendWithTemplateResponseExample.json +46 -0
  835. data/oas/examples/json/SignatureRequestUpdateRequestDefaultExample.json +4 -0
  836. data/oas/examples/json/SignatureRequestUpdateResponseExample.json +32 -0
  837. data/oas/examples/json/TeamAddMemberRequestAccountIdExample.json +3 -0
  838. data/oas/examples/json/TeamAddMemberRequestEmailAddressExample.json +3 -0
  839. data/oas/examples/json/TeamAddMemberResponseExample.json +34 -0
  840. data/oas/examples/json/TeamCreateRequestDefaultExample.json +3 -0
  841. data/oas/examples/json/TeamCreateResponseExample.json +21 -0
  842. data/oas/examples/json/TeamDoesNotExistResponseExample.json +6 -0
  843. data/oas/examples/json/TeamGetInfoResponseExample.json +12 -0
  844. data/oas/examples/json/TeamGetResponseExample.json +34 -0
  845. data/oas/examples/json/TeamGetRootInfoResponseExample.json +9 -0
  846. data/oas/examples/json/TeamMembersResponseExample.json +20 -0
  847. data/oas/examples/json/TeamRemoveMemberRequestAccountIdExample.json +3 -0
  848. data/oas/examples/json/TeamRemoveMemberRequestEmailAddressExample.json +4 -0
  849. data/oas/examples/json/TeamRemoveMemberResponseExample.json +21 -0
  850. data/oas/examples/json/TeamSubTeamsResponseExample.json +18 -0
  851. data/oas/examples/json/TeamUpdateRequestDefaultExample.json +3 -0
  852. data/oas/examples/json/TeamUpdateResponseExample.json +21 -0
  853. data/oas/examples/json/TemplateAddUserRequestDefaultExample.json +3 -0
  854. data/oas/examples/json/TemplateAddUserResponseExample.json +202 -0
  855. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json +36 -0
  856. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormDataExample.json +36 -0
  857. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json +75 -0
  858. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json +85 -0
  859. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json +66 -0
  860. data/oas/examples/json/TemplateCreateEmbeddedDraftResponseExample.json +7 -0
  861. data/oas/examples/json/TemplateFilesResponseExample.json +4 -0
  862. data/oas/examples/json/TemplateGetResponseExample.json +190 -0
  863. data/oas/examples/json/TemplateListResponseExample.json +263 -0
  864. data/oas/examples/json/TemplateRemoveUserRequestDefaultExample.json +3 -0
  865. data/oas/examples/json/TemplateRemoveUserResponseExample.json +190 -0
  866. data/oas/examples/json/TemplateUpdateFilesRequestDefaultExample.json +5 -0
  867. data/oas/examples/json/TemplateUpdateFilesRequestFormDataExample.json +5 -0
  868. data/oas/examples/json/TemplateUpdateFilesResponseExample.json +5 -0
  869. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json +8 -0
  870. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormDataExample.json +8 -0
  871. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json +47 -0
  872. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json +57 -0
  873. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json +38 -0
  874. data/oas/examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json +10 -0
  875. data/oas/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json +21 -0
  876. data/oas/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestFormDataExample.json +24 -0
  877. data/oas/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json +9 -0
  878. data/oas/examples/json/UnclaimedDraftCreateRequestDefaultExample.json +14 -0
  879. data/oas/examples/json/UnclaimedDraftCreateRequestFormDataExample.json +6 -0
  880. data/oas/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json +45 -0
  881. data/oas/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json +55 -0
  882. data/oas/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json +36 -0
  883. data/oas/examples/json/UnclaimedDraftCreateResponseExample.json +8 -0
  884. data/oas/examples/json/UnclaimedDraftEditAndResendExample.json +10 -0
  885. data/oas/examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json +4 -0
  886. data/oas/markdown/en/descriptions/account-callback-description.md +5 -0
  887. data/oas/markdown/en/descriptions/api-app-callback-description.md +5 -0
  888. data/oas/markdown/en/tags/account-tag-description.md +1 -0
  889. data/oas/markdown/en/tags/api-app-tag-description.md +1 -0
  890. data/oas/markdown/en/tags/bulk-send-job-tag-description.md +1 -0
  891. data/oas/markdown/en/tags/callbacks-tag-description.md +7 -0
  892. data/oas/markdown/en/tags/embedded-tag-description.md +1 -0
  893. data/oas/markdown/en/tags/oauth-tag-description.md +20 -0
  894. data/oas/markdown/en/tags/report-tag-description.md +1 -0
  895. data/oas/markdown/en/tags/signature-request-tag-description.md +1 -0
  896. data/oas/markdown/en/tags/team-tag-description.md +1 -0
  897. data/oas/markdown/en/tags/template-tag-description.md +1 -0
  898. data/oas/markdown/en/tags/unclaimed-draft-tag-description.md +1 -0
  899. data/oas/openapi-raw.yaml +9709 -0
  900. data/oas/openapi-sdk.yaml +10206 -0
  901. data/oas/openapi.yaml +10251 -0
  902. data/oas/src/Hello/OpenApi/RawFile.php +220 -0
  903. data/oas/src/Hello/OpenApi/TranslationResult.php +53 -0
  904. data/oas/test_fixtures/AccountCreateRequest.json +7 -0
  905. data/oas/test_fixtures/AccountCreateResponse.json +15 -0
  906. data/oas/test_fixtures/AccountGetResponse.json +14 -0
  907. data/oas/test_fixtures/AccountUpdateRequest.json +5 -0
  908. data/oas/test_fixtures/AccountVerifyRequest.json +5 -0
  909. data/oas/test_fixtures/AccountVerifyResponse.json +7 -0
  910. data/oas/test_fixtures/ApiAppCreateRequest.json +36 -0
  911. data/oas/test_fixtures/ApiAppGetResponse.json +27 -0
  912. data/oas/test_fixtures/ApiAppListResponse.json +42 -0
  913. data/oas/test_fixtures/ApiAppUpdateRequest.json +36 -0
  914. data/oas/test_fixtures/BulkSendJobGetResponse.json +67 -0
  915. data/oas/test_fixtures/BulkSendJobListResponse.json +24 -0
  916. data/oas/test_fixtures/BulkSendJobSendResponse.json +10 -0
  917. data/oas/test_fixtures/EmbeddedEditUrlRequest.json +28 -0
  918. data/oas/test_fixtures/EmbeddedEditUrlResponse.json +8 -0
  919. data/oas/test_fixtures/EmbeddedSignUrlResponse.json +8 -0
  920. data/oas/test_fixtures/ErrorResponse.json +9 -0
  921. data/oas/test_fixtures/EventCallbackHelper.json +50 -0
  922. data/oas/test_fixtures/FileResponse.json +6 -0
  923. data/oas/test_fixtures/OAuthTokenGenerateRequest.json +9 -0
  924. data/oas/test_fixtures/OAuthTokenRefreshRequest.json +6 -0
  925. data/oas/test_fixtures/OAuthTokenResponse.json +15 -0
  926. data/oas/test_fixtures/ReportCreateRequest.json +10 -0
  927. data/oas/test_fixtures/ReportCreateResponse.json +13 -0
  928. data/oas/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +68 -0
  929. data/oas/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +67 -0
  930. data/oas/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +121 -0
  931. data/oas/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +63 -0
  932. data/oas/test_fixtures/SignatureRequestGetResponse.json +146 -0
  933. data/oas/test_fixtures/SignatureRequestListResponse.json +102 -0
  934. data/oas/test_fixtures/SignatureRequestRemindRequest.json +5 -0
  935. data/oas/test_fixtures/SignatureRequestSendRequest.json +271 -0
  936. data/oas/test_fixtures/SignatureRequestSendWithTemplateRequest.json +48 -0
  937. data/oas/test_fixtures/SignatureRequestUpdateRequest.json +7 -0
  938. data/oas/test_fixtures/SubFormFieldsPerDocument.json +107 -0
  939. data/oas/test_fixtures/TeamAddMemberRequest.json +6 -0
  940. data/oas/test_fixtures/TeamCreateRequest.json +5 -0
  941. data/oas/test_fixtures/TeamGetResponse.json +34 -0
  942. data/oas/test_fixtures/TeamRemoveMemberRequest.json +7 -0
  943. data/oas/test_fixtures/TeamUpdateRequest.json +5 -0
  944. data/oas/test_fixtures/TemplateAddUserRequest.json +7 -0
  945. data/oas/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +121 -0
  946. data/oas/test_fixtures/TemplateCreateEmbeddedDraftResponse.json +9 -0
  947. data/oas/test_fixtures/TemplateGetResponse.json +102 -0
  948. data/oas/test_fixtures/TemplateListResponse.json +143 -0
  949. data/oas/test_fixtures/TemplateRemoveUserRequest.json +6 -0
  950. data/oas/test_fixtures/TemplateUpdateFilesRequest.json +14 -0
  951. data/oas/test_fixtures/TemplateUpdateFilesResponse.json +7 -0
  952. data/oas/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +137 -0
  953. data/oas/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +70 -0
  954. data/oas/test_fixtures/UnclaimedDraftCreateRequest.json +122 -0
  955. data/oas/test_fixtures/UnclaimedDraftCreateResponse.json +9 -0
  956. data/oas/test_fixtures/UnclaimedDraftEditAndResendRequest.json +15 -0
  957. data/oas/test_fixtures/pdf-sample-2.pdf +0 -0
  958. data/oas/test_fixtures/pdf-sample.pdf +0 -0
  959. data/oas/translations/en-plugin.json +8 -0
  960. data/oas/translations/en.yaml +1513 -0
  961. data/openapi-config.yaml +21 -0
  962. data/run-build +47 -0
  963. data/spec/api/account_api_spec.rb +110 -0
  964. data/spec/api/api_app_api_spec.rb +94 -0
  965. data/spec/api/bulk_send_job_api_spec.rb +55 -0
  966. data/spec/api/embedded_api_spec.rb +58 -0
  967. data/spec/api/oauth_api_spec.rb +58 -0
  968. data/spec/api/report_api_spec.rb +41 -0
  969. data/spec/api/signature_request_api_spec.rb +265 -0
  970. data/spec/api/team_api_spec.rb +108 -0
  971. data/spec/api/template_api_spec.rb +153 -0
  972. data/spec/api/unclaimed_draft_api_spec.rb +94 -0
  973. data/spec/api_client_spec.rb +226 -0
  974. data/spec/configuration_spec.rb +42 -0
  975. data/spec/event_callback_helper_spec.rb +25 -0
  976. data/spec/fixtures_spec.rb +60 -0
  977. data/spec/models/deserialize_spec.rb +53 -0
  978. data/spec/models/sub_form_fields_per_document_base_spec.rb +30 -0
  979. data/spec/spec_helper.rb +97 -90
  980. data/spec/test_utils.rb +27 -0
  981. data/templates/Gemfile.mustache +10 -0
  982. data/templates/README.mustache +119 -0
  983. data/templates/Rakefile.mustache +10 -0
  984. data/templates/api.mustache +280 -0
  985. data/templates/api_client.mustache +288 -0
  986. data/templates/api_client_faraday_partial.mustache +136 -0
  987. data/templates/api_client_spec.mustache +220 -0
  988. data/templates/api_client_typhoeus_partial.mustache +153 -0
  989. data/templates/api_doc.mustache +77 -0
  990. data/templates/api_error.mustache +49 -0
  991. data/templates/api_info.mustache +12 -0
  992. data/templates/api_test.mustache +47 -0
  993. data/templates/base_object.mustache +146 -0
  994. data/templates/configuration.mustache +383 -0
  995. data/templates/configuration_spec.mustache +34 -0
  996. data/templates/configuration_tls_faraday_partial.mustache +29 -0
  997. data/templates/configuration_tls_typhoeus_partial.mustache +34 -0
  998. data/templates/event_callback_helper.mustache +24 -0
  999. data/templates/gem.mustache +52 -0
  1000. data/templates/gemspec.mustache +35 -0
  1001. data/templates/git_push.sh.mustache +57 -0
  1002. data/templates/gitignore.mustache +41 -0
  1003. data/templates/model.mustache +26 -0
  1004. data/templates/model_doc.mustache +12 -0
  1005. data/templates/model_test.mustache +77 -0
  1006. data/templates/partial_model_enum_class.mustache +20 -0
  1007. data/templates/partial_model_generic.mustache +402 -0
  1008. data/templates/partial_model_generic_doc.mustache +10 -0
  1009. data/templates/partial_oneof_module.mustache +137 -0
  1010. data/templates/partial_oneof_module_doc.mustache +92 -0
  1011. data/templates/rspec.mustache +2 -0
  1012. data/templates/rubocop.mustache +148 -0
  1013. data/templates/spec_helper.mustache +103 -0
  1014. data/templates/travis.mustache +14 -0
  1015. data/templates/version.mustache +7 -0
  1016. data/vendor/autoload.php +7 -0
  1017. data/vendor/bin/yaml-lint +117 -0
  1018. data/vendor/composer/ClassLoader.php +572 -0
  1019. data/vendor/composer/InstalledVersions.php +350 -0
  1020. data/vendor/composer/LICENSE +21 -0
  1021. data/vendor/composer/autoload_classmap.php +10 -0
  1022. data/vendor/composer/autoload_files.php +11 -0
  1023. data/vendor/composer/autoload_namespaces.php +9 -0
  1024. data/vendor/composer/autoload_psr4.php +11 -0
  1025. data/vendor/composer/autoload_real.php +80 -0
  1026. data/vendor/composer/autoload_static.php +46 -0
  1027. data/vendor/composer/installed.json +239 -0
  1028. data/vendor/composer/installed.php +50 -0
  1029. data/vendor/composer/platform_check.php +26 -0
  1030. data/vendor/symfony/deprecation-contracts/.gitignore +3 -0
  1031. data/vendor/symfony/deprecation-contracts/CHANGELOG.md +5 -0
  1032. data/vendor/symfony/deprecation-contracts/LICENSE +19 -0
  1033. data/vendor/symfony/deprecation-contracts/README.md +26 -0
  1034. data/vendor/symfony/deprecation-contracts/composer.json +35 -0
  1035. data/vendor/symfony/deprecation-contracts/function.php +27 -0
  1036. data/vendor/symfony/polyfill-ctype/Ctype.php +232 -0
  1037. data/vendor/symfony/polyfill-ctype/LICENSE +19 -0
  1038. data/vendor/symfony/polyfill-ctype/README.md +12 -0
  1039. data/vendor/symfony/polyfill-ctype/bootstrap.php +50 -0
  1040. data/vendor/symfony/polyfill-ctype/bootstrap80.php +46 -0
  1041. data/vendor/symfony/polyfill-ctype/composer.json +41 -0
  1042. data/vendor/symfony/yaml/CHANGELOG.md +237 -0
  1043. data/vendor/symfony/yaml/Command/LintCommand.php +289 -0
  1044. data/vendor/symfony/yaml/Dumper.php +140 -0
  1045. data/vendor/symfony/yaml/Escaper.php +95 -0
  1046. data/vendor/symfony/yaml/Exception/DumpException.php +21 -0
  1047. data/vendor/symfony/yaml/Exception/ExceptionInterface.php +21 -0
  1048. data/vendor/symfony/yaml/Exception/ParseException.php +132 -0
  1049. data/vendor/symfony/yaml/Exception/RuntimeException.php +21 -0
  1050. data/vendor/symfony/yaml/Inline.php +812 -0
  1051. data/vendor/symfony/yaml/LICENSE +19 -0
  1052. data/vendor/symfony/yaml/Parser.php +1305 -0
  1053. data/vendor/symfony/yaml/README.md +13 -0
  1054. data/vendor/symfony/yaml/Resources/bin/yaml-lint +45 -0
  1055. data/vendor/symfony/yaml/Tag/TaggedValue.php +38 -0
  1056. data/vendor/symfony/yaml/Unescaper.php +132 -0
  1057. data/vendor/symfony/yaml/Yaml.php +100 -0
  1058. data/vendor/symfony/yaml/composer.json +42 -0
  1059. metadata +1092 -182
  1060. data/.gitignore +0 -19
  1061. data/.rspec +0 -2
  1062. data/.travis.yml +0 -15
  1063. data/CONTRIBUTING.md +0 -42
  1064. data/Guardfile +0 -14
  1065. data/lib/hello_sign/.error.rb.swp +0 -0
  1066. data/lib/hello_sign/api/account.rb +0 -78
  1067. data/lib/hello_sign/api/api_app.rb +0 -121
  1068. data/lib/hello_sign/api/bulk_send_job.rb +0 -62
  1069. data/lib/hello_sign/api/embedded.rb +0 -68
  1070. data/lib/hello_sign/api/oauth.rb +0 -95
  1071. data/lib/hello_sign/api/signature_request.rb +0 -662
  1072. data/lib/hello_sign/api/team.rb +0 -107
  1073. data/lib/hello_sign/api/template.rb +0 -227
  1074. data/lib/hello_sign/api/unclaimed_draft.rb +0 -328
  1075. data/lib/hello_sign/api.rb +0 -31
  1076. data/lib/hello_sign/client.rb +0 -369
  1077. data/lib/hello_sign/configuration.rb +0 -78
  1078. data/lib/hello_sign/error.rb +0 -99
  1079. data/lib/hello_sign/resource/account.rb +0 -43
  1080. data/lib/hello_sign/resource/api_app.rb +0 -43
  1081. data/lib/hello_sign/resource/base_resource.rb +0 -73
  1082. data/lib/hello_sign/resource/bulk_send_job.rb +0 -43
  1083. data/lib/hello_sign/resource/embedded.rb +0 -43
  1084. data/lib/hello_sign/resource/resource_array.rb +0 -56
  1085. data/lib/hello_sign/resource/signature_request.rb +0 -43
  1086. data/lib/hello_sign/resource/team.rb +0 -43
  1087. data/lib/hello_sign/resource/template.rb +0 -43
  1088. data/lib/hello_sign/resource/template_draft.rb +0 -44
  1089. data/lib/hello_sign/resource/unclaimed_draft.rb +0 -44
  1090. data/lib/hello_sign/resource.rb +0 -33
  1091. data/lib/hello_sign/version.rb +0 -25
  1092. data/lib/hello_sign.rb +0 -50
  1093. data/spec/fixtures/account.json +0 -15
  1094. data/spec/fixtures/api_app.json +0 -16
  1095. data/spec/fixtures/api_apps.json +0 -43
  1096. data/spec/fixtures/bulk_send_job.json +0 -88
  1097. data/spec/fixtures/bulk_send_jobs.json +0 -22
  1098. data/spec/fixtures/embedded.json +0 -6
  1099. data/spec/fixtures/empty.pdf +0 -0
  1100. data/spec/fixtures/error.json +0 -6
  1101. data/spec/fixtures/headers.json +0 -18
  1102. data/spec/fixtures/nda.pdf +0 -0
  1103. data/spec/fixtures/signature_request.json +0 -45
  1104. data/spec/fixtures/signature_requests.json +0 -44
  1105. data/spec/fixtures/team.json +0 -15
  1106. data/spec/fixtures/template.json +0 -53
  1107. data/spec/fixtures/templates.json +0 -59
  1108. data/spec/fixtures/token.json +0 -14
  1109. data/spec/fixtures/unclaimed_draft.json +0 -6
  1110. data/spec/hello_sign/.error_spec.rb.swp +0 -0
  1111. data/spec/hello_sign/api/account_spec.rb +0 -42
  1112. data/spec/hello_sign/api/api_app_spec.rb +0 -104
  1113. data/spec/hello_sign/api/bulk_send_job_spec.rb +0 -53
  1114. data/spec/hello_sign/api/embedded_spec.rb +0 -23
  1115. data/spec/hello_sign/api/oauth_spec.rb +0 -27
  1116. data/spec/hello_sign/api/signature_request_spec.rb +0 -230
  1117. data/spec/hello_sign/api/team_spec.rb +0 -101
  1118. data/spec/hello_sign/api/template_spec.rb +0 -172
  1119. data/spec/hello_sign/api/unclaimed_draft_spec.rb +0 -145
  1120. data/spec/hello_sign/client_spec.rb +0 -191
  1121. data/spec/hello_sign/error_spec.rb +0 -10
  1122. data/spec/hello_sign/resource/base_resource_spec.rb +0 -53
  1123. data/spec/hello_sign_spec.rb +0 -57
  1124. data/spec/scenarios/uploads_spec.rb +0 -19
@@ -0,0 +1,1513 @@
1
+ ##############
2
+ # OAS Config #
3
+ ##############
4
+
5
+ "OpenApi::TITLE": HelloSign API
6
+ "OpenApi::DESCRIPTION": HelloSign v3 API
7
+ "OpenApi::AUTH::API_KEY": |-
8
+ Your API key can be used to make calls to the HelloSign API. See [Authentication](/api/reference/authentication) for more information.
9
+ ✅ Supported by Try it console (calls sent in `test_mode` only).
10
+ "OpenApi::AUTH::OAUTH": |-
11
+ You can use an Access Token issued through an OAuth flow to send calls to the HelloSign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information.
12
+ ❌ **Not supported** by Try it console.
13
+ "OpenApi::TAG::ACCOUNT::DESCRIPTION": ./markdown/en/tags/account-tag-description.md
14
+ "OpenApi::TAG::API_APP::DESCRIPTION": ./markdown/en/tags/api-app-tag-description.md
15
+ "OpenApi::TAG::BULK_SEND_JOB::DESCRIPTION": ./markdown/en/tags/bulk-send-job-tag-description.md
16
+ "OpenApi::TAG::EMBEDDED::DESCRIPTION": ./markdown/en/tags/embedded-tag-description.md
17
+ "OpenApi::TAG::REPORT::DESCRIPTION": ./markdown/en/tags/report-tag-description.md
18
+ "OpenApi::TAG::SIGNATURE_REQUEST::DESCRIPTION": ./markdown/en/tags/signature-request-tag-description.md
19
+ "OpenApi::TAG::TEAM::DESCRIPTION": ./markdown/en/tags/team-tag-description.md
20
+ "OpenApi::TAG::TEMPLATE::DESCRIPTION": ./markdown/en/tags/template-tag-description.md
21
+ "OpenApi::TAG::UNCLAIMED_DRAFT::DESCRIPTION": ./markdown/en/tags/unclaimed-draft-tag-description.md
22
+ "OpenApi::TAG::OAUTH::DESCRIPTION": ./markdown/en/tags/oauth-tag-description.md
23
+ "OpenApi::TAG::CALLBACKS_AND_EVENTS::DESCRIPTION": ./markdown/en/tags/callbacks-tag-description.md
24
+
25
+ "OpenApi::ACCOUNT_CALLBACK::SUMMARY": Account Callbacks
26
+ "OpenApi::ACCOUNT_CALLBACK::DESCRIPTION": ./markdown/en/descriptions/account-callback-description.md
27
+
28
+ "OpenApi::APP_CALLBACK::SUMMARY": App Callbacks
29
+ "OpenApi::APP_CALLBACK::DESCRIPTION": ./markdown/en/descriptions/api-app-callback-description.md
30
+
31
+ ##################
32
+ # Request Models #
33
+ ##################
34
+
35
+ "AccountCreate::DESCRIPTION": Creates a new HelloSign Account that is associated with the specified `email_address`.
36
+ "AccountCreate::SUMMARY": Create Account
37
+ "AccountCreate::CLIENT_ID": |-
38
+ Used when creating a new account with OAuth authorization.
39
+
40
+ See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
41
+ "AccountCreate::CLIENT_SECRET": |-
42
+ Used when creating a new account with OAuth authorization.
43
+
44
+ See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
45
+ "AccountCreate::EMAIL_ADDRESS": The email address which will be associated with the new Account.
46
+ "AccountCreate::LOCALE": The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
47
+
48
+ "AccountGet::DESCRIPTION": Returns the properties and settings of your Account.
49
+ "AccountGet::SUMMARY": Get Account
50
+ "AccountGet::ACCOUNT_ID": The ID of the Account
51
+
52
+ "AccountUpdate::SUMMARY": Update Account
53
+ "AccountUpdate::DESCRIPTION": Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.
54
+ "AccountUpdate::ACCOUNT_ID": The ID of the Account
55
+ "AccountUpdate::CALLBACK_URL": The URL that HelloSign should POST events to.
56
+ "AccountUpdate::LOCALE": The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
57
+
58
+ "AccountVerify::SUMMARY": Verify Account
59
+ "AccountVerify::DESCRIPTION": |-
60
+ Verifies whether an HelloSign Account exists for the given email address.
61
+ "AccountVerify::EMAIL_ADDRESS": Email address to run the verification for.
62
+
63
+ "ApiAppCreate::SUMMARY": Create API App
64
+ "ApiAppCreate::DESCRIPTION": Creates a new API App.
65
+ "ApiAppCreate::CALLBACK_URL": The URL at which the ApiApp should receive event callbacks.
66
+ "ApiAppCreate::CUSTOM_LOGO_FILE": An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
67
+ "ApiAppCreate::DOMAINS": The domain names the ApiApp will be associated with.
68
+ "ApiAppCreate::NAME": The name you want to assign to the ApiApp.
69
+
70
+ "ApiAppDelete::SUMMARY": Delete API App
71
+ "ApiAppDelete::DESCRIPTION": Deletes an API App. Can only be invoked for apps you own.
72
+ "ApiAppDelete::CLIENT_ID": The client id of the API App to delete.
73
+
74
+ "ApiAppGet::SUMMARY": Get API App
75
+ "ApiAppGet::DESCRIPTION": Returns an object with information about an API App.
76
+ "ApiAppGet::CLIENT_ID": The client id of the API App to retrieve.
77
+
78
+ "ApiAppList::SUMMARY": List API Apps
79
+ "ApiAppList::DESCRIPTION": Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.
80
+ "ApiAppList::PAGE": Which page number of the API App List to return. Defaults to `1`.
81
+ "ApiAppList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
82
+
83
+ "ApiAppUpdate::SUMMARY": Update API App
84
+ "ApiAppUpdate::DESCRIPTION": Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.
85
+ "ApiAppUpdate::CALLBACK_URL": The URL at which the API App should receive event callbacks.
86
+ "ApiAppUpdate::CLIENT_ID": The client id of the API App to update.
87
+ "ApiAppUpdate::CUSTOM_LOGO_FILE": An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
88
+ "ApiAppUpdate::DOMAINS": The domain names the ApiApp will be associated with.
89
+ "ApiAppUpdate::NAME": The name you want to assign to the ApiApp.
90
+ "ApiAppUpdate::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
91
+
92
+ "BulkSendJobGet::SUMMARY": Get Bulk Send Job
93
+ "BulkSendJobGet::DESCRIPTION": Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
94
+ "BulkSendJobGet::BULK_SEND_JOB_ID": The id of the BulkSendJob to retrieve.
95
+
96
+ "BulkSendJobList::SUMMARY": List Bulk Send Jobs
97
+ "BulkSendJobList::DESCRIPTION": Returns a list of BulkSendJob that you can access.
98
+ "BulkSendJobList::PAGE": Which page number of the BulkSendJob List to return. Defaults to `1`.
99
+ "BulkSendJobList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.
100
+
101
+ "EmbeddedEditUrl::SUMMARY": Get Embedded Template Edit URL
102
+ "EmbeddedEditUrl::DESCRIPTION": Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.
103
+ "EmbeddedEditUrl::ALLOW_EDIT_CCS": This allows the requester to enable/disable to add or change CC roles when editing the template.
104
+ "EmbeddedEditUrl::CC_ROLES": The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.
105
+ "EmbeddedEditUrl::FORCE_SIGNER_ROLES": Provide users the ability to review/edit the template signer roles.
106
+ "EmbeddedEditUrl::FORCE_SUBJECT_MESSAGE": Provide users the ability to review/edit the template subject and message.
107
+ "EmbeddedEditUrl::MERGE_FIELDS": |-
108
+ Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.
109
+
110
+ Remove all merge fields on the template by passing an empty array `[]`.
111
+ "EmbeddedEditUrl::PREVIEW_ONLY": |-
112
+ This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
113
+
114
+ **Note**: This parameter overwrites `show_preview=true` (if set).
115
+ "EmbeddedEditUrl::SHOW_PREVIEW": This allows the requester to enable the editor/preview experience.
116
+ "EmbeddedEditUrl::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
117
+ "EmbeddedEditUrl::TEMPLATE_ID": The id of the template to edit.
118
+ "EmbeddedEditUrl::TEST_MODE": Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.
119
+
120
+ "EmbeddedSignUrl::SUMMARY": Get Embedded Sign URL
121
+ "EmbeddedSignUrl::DESCRIPTION": Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.
122
+ "EmbeddedSignUrl::SIGNATURE_ID": The id of the signature to get a signature url for.
123
+
124
+ "OAuthTokenGenerate::SUMMARY": OAuth Token Generate
125
+ "OAuthTokenGenerate::DESCRIPTION": Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
126
+ "OAuthTokenGenerate::CLIENT_ID": The client id of the app requesting authorization.
127
+ "OAuthTokenGenerate::CLIENT_SECRET": The secret token of your app.
128
+ "OAuthTokenGenerate::CODE": The code passed to your callback when the user granted access.
129
+ "OAuthTokenGenerate::GRANT_TYPE": When generating a new token use `authorization_code`.
130
+ "OAuthTokenGenerate::STATE": Same as the state you specified earlier.
131
+
132
+ "OAuthTokenRefresh::SUMMARY": OAuth Token Refresh
133
+ "OAuthTokenRefresh::DESCRIPTION": Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired.
134
+ "OAuthTokenRefresh::GRANT_TYPE": When refreshing an existing token use `refresh_token`.
135
+ "OAuthTokenRefresh::REFRESH_TOKEN": The token provided when you got the expired access token.
136
+
137
+ "ReportCreate::SUMMARY": Create Report
138
+ "ReportCreate::DESCRIPTION": |-
139
+ Request the creation of one or more report(s).
140
+
141
+ When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past.
142
+ "ReportCreate::END_DATE": The (inclusive) end date for the report data in `MM/DD/YYYY` format.
143
+ "ReportCreate::REPORT_TYPE": The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).
144
+ "ReportCreate::START_DATE": The (inclusive) start date for the report data in `MM/DD/YYYY` format.
145
+
146
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::SUMMARY": Embedded Bulk Send with Template
147
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::DESCRIPTION": |-
148
+ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
149
+
150
+ **NOTE**: Only available for Standard plan and higher.
151
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
152
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::CLIENT_ID": Client id of the app you're using to create this embedded signature request. Used for security purposes.
153
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
154
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_FILE": |-
155
+ `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
156
+
157
+ - `name`: the name of the signer filling the role of RoleName
158
+ - `email_address`: email address of the signer filling the role of RoleName
159
+ - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
160
+ - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
161
+
162
+ **Note**: Not available in test mode and requires a Standard plan or higher.
163
+ - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
164
+
165
+ You may only specify field values here, any other options should be set in the custom_fields request parameter.
166
+
167
+ Example CSV:
168
+
169
+ ```
170
+ name, email_address, pin, company_field
171
+ George, george@example.com, d79a3td, ABC Corp
172
+ Mary, mary@example.com, gd9as5b, 123 LLC
173
+ ```
174
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_LIST": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
175
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
176
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
177
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
178
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
179
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
180
+
181
+ "SignatureRequestBulkSendWithTemplate::SUMMARY": Bulk Send with Template
182
+ "SignatureRequestBulkSendWithTemplate::DESCRIPTION": |-
183
+ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter.
184
+
185
+ **NOTE**: Only available for Standard plan and higher.
186
+ "SignatureRequestBulkSendWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
187
+ "SignatureRequestBulkSendWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
188
+ "SignatureRequestBulkSendWithTemplate::SIGNER_FILE": |-
189
+ `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
190
+
191
+ - `name`: the name of the signer filling the role of RoleName
192
+ - `email_address`: email address of the signer filling the role of RoleName
193
+ - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
194
+ - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
195
+
196
+ **Note**: Not available in test mode and requires a Standard plan or higher.
197
+ - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
198
+
199
+ You may only specify field values here, any other options should be set in the custom_fields request parameter.
200
+
201
+ Example CSV:
202
+
203
+ ```
204
+ name, email_address, pin, company_field
205
+ George, george@example.com, d79a3td, ABC Corp
206
+ Mary, mary@example.com, gd9as5b, 123 LLC
207
+ ```
208
+ "SignatureRequestBulkSendWithTemplate::SIGNER_LIST": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
209
+ "SignatureRequestBulkSendWithTemplate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
210
+ "SignatureRequestBulkSendWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
211
+ "SignatureRequestBulkSendWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
212
+ "SignatureRequestBulkSendWithTemplate::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
213
+ "SignatureRequestBulkSendWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
214
+ "SignatureRequestBulkSendWithTemplate::CLIENT_ID" : The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
215
+
216
+ "SignatureRequestCancel::SUMMARY": Cancel Incomplete Signature Request
217
+ "SignatureRequestCancel::DESCRIPTION": |-
218
+ Cancels an incomplete signature request. This action is **not reversible**.
219
+
220
+ 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.
221
+
222
+ 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.
223
+
224
+ 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.
225
+
226
+ **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
227
+ "SignatureRequestCancel::SIGNATURE_REQUEST_ID": The id of the incomplete SignatureRequest to cancel.
228
+
229
+ "SignatureRequestCreateEmbedded::SUMMARY": Create Embedded Signature Request
230
+ "SignatureRequestCreateEmbedded::DESCRIPTION": Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
231
+ "SignatureRequestCreateEmbedded::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
232
+ "SignatureRequestCreateEmbedded::ALLOW_REASSIGN": |-
233
+ Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
234
+
235
+ **Note**: Only available for Premium plan.
236
+ "SignatureRequestCreateEmbedded::CC_EMAIL_ADDRESSES": The email addresses that should be CCed.
237
+ "SignatureRequestCreateEmbedded::CLIENT_ID": Client id of the app you're using to create this embedded signature request. Used for security purposes.
238
+ "SignatureRequestCreateEmbedded::FILE": |-
239
+ Use `file[]` to indicate the uploaded file(s) to send for signature.
240
+
241
+ This endpoint requires either **file** or **file_url[]**, but not both.
242
+ "SignatureRequestCreateEmbedded::FILE_URL": |-
243
+ Use `file_url[]` to have HelloSign download the file(s) to send for signature.
244
+
245
+ This endpoint requires either **file** or **file_url[]**, but not both.
246
+ "SignatureRequestCreateEmbedded::HIDE_TEXT_TAGS": |-
247
+ Enables automatic Text Tag removal when set to true.
248
+
249
+ **NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
250
+ "SignatureRequestCreateEmbedded::POPULATE_AUTO_FILL_FIELDS": |-
251
+ Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
252
+
253
+ ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
254
+ "SignatureRequestCreateEmbedded::MESSAGE": The custom message in the email that will be sent to the signers.
255
+ "SignatureRequestCreateEmbedded::SUBJECT": The subject in the email that will be sent to the signers.
256
+ "SignatureRequestCreateEmbedded::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
257
+ "SignatureRequestCreateEmbedded::TITLE": The title you want to assign to the SignatureRequest.
258
+ "SignatureRequestCreateEmbedded::USE_TEXT_TAGS": Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
259
+
260
+ "SignatureRequestCreateEmbeddedWithTemplate::SUMMARY": Create Embedded Signature Request with Template
261
+ "SignatureRequestCreateEmbeddedWithTemplate::DESCRIPTION": Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
262
+ "SignatureRequestCreateEmbeddedWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
263
+ "SignatureRequestCreateEmbeddedWithTemplate::CLIENT_ID": Client id of the app you're using to create this embedded signature request. Used for security purposes.
264
+ "SignatureRequestCreateEmbeddedWithTemplate::FILE": |-
265
+ Use `file[]` to indicate the uploaded file(s) to send for signature.
266
+
267
+ This endpoint requires either **file** or **file_url[]**, but not both.
268
+ "SignatureRequestCreateEmbeddedWithTemplate::FILE_URL": |-
269
+ Use `file_url[]` to have HelloSign download the file(s) to send for signature.
270
+
271
+ This endpoint requires either **file** or **file_url[]**, but not both.
272
+ "SignatureRequestCreateEmbeddedWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
273
+ "SignatureRequestCreateEmbeddedWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
274
+ "SignatureRequestCreateEmbeddedWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
275
+ "SignatureRequestCreateEmbeddedWithTemplate::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
276
+ "SignatureRequestCreateEmbeddedWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
277
+ "SignatureRequestCreateEmbeddedWithTemplate::POPULATE_AUTO_FILL_FIELDS": |-
278
+ Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
279
+
280
+ ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
281
+ "SignatureRequestFiles::SUMMARY": Download Files
282
+ "SignatureRequestFiles::DESCRIPTION": |-
283
+ Obtain a copy of the current documents specified by the `signature_request_id` parameter.
284
+
285
+ Returns a PDF or ZIP file, or if `get_url` is set, a JSON object with a url to the file (PDFs only). If `get_data_uri` is set, a JSON object with a `data_uri` representing the base64 encoded file (PDFs only) is returned.
286
+
287
+ If the files are currently being prepared, a status code of `409` will be returned instead.
288
+ "SignatureRequestFiles::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to retrieve.
289
+ "SignatureRequestFiles::FILE_TYPE": Set to `pdf` for a single merged document or `zip` for a collection of individual documents.
290
+ "SignatureRequestFiles::GET_DATA_URI": If `true`, the response will contain the file as base64 encoded string. Base64 encoding is only available for PDFs.
291
+ "SignatureRequestFiles::GET_URL": If `true`, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days.
292
+
293
+ "SignatureRequestGet::SUMMARY": Get Signature Request
294
+ "SignatureRequestGet::DESCRIPTION": Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
295
+ "SignatureRequestGet::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to retrieve.
296
+
297
+ "SignatureRequestList::SUMMARY": List Signature Requests
298
+ "SignatureRequestList::DESCRIPTION": |-
299
+ Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on.
300
+
301
+ Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
302
+ "SignatureRequestList::ACCOUNT_ID": Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.
303
+ "SignatureRequestList::PAGE": Which page number of the SignatureRequest List to return. Defaults to `1`.
304
+ "SignatureRequestList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
305
+ "SignatureRequestList::QUERY": String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
306
+
307
+ "SignatureRequestReleaseHold::SUMMARY": Release On-Hold Signature Request
308
+ "SignatureRequestReleaseHold::DESCRIPTION": Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.
309
+ "SignatureRequestReleaseHold::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to release.
310
+
311
+ "SignatureRequestRemind::SUMMARY": Send Request Reminder
312
+ "SignatureRequestRemind::DESCRIPTION": |-
313
+ Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders.
314
+
315
+ **NOTE**: This action can **not** be used with embedded signature requests.
316
+ "SignatureRequestRemind::EMAIL_ADDRESS": The email address of the signer to send a reminder to.
317
+ "SignatureRequestRemind::NAME": The name of the signer to send a reminder to. Include if two or more
318
+ signers share an email address.
319
+ "SignatureRequestRemind::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to send a reminder for.
320
+
321
+ "SignatureRequestRemove::SUMMARY": Remove Signature Request Access
322
+ "SignatureRequestRemove::DESCRIPTION": |-
323
+ Removes your access to a completed signature request. This action is **not reversible**.
324
+
325
+ The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s).
326
+
327
+ Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
328
+ "SignatureRequestRemove::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to remove.
329
+
330
+ "SignatureRequestSend::SUMMARY": Send Signature Request
331
+ "SignatureRequestSend::DESCRIPTION": Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
332
+ "SignatureRequestSend::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
333
+ "SignatureRequestSend::ALLOW_REASSIGN": |-
334
+ Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
335
+
336
+ **Note**: Only available for Premium plan and higher.
337
+ "SignatureRequestSend::CC_EMAIL_ADDRESSES": The email addresses that should be CCed.
338
+ "SignatureRequestSend::CLIENT_ID": The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
339
+ "SignatureRequestSend::FILE": |-
340
+ Use `file[]` to indicate the uploaded file(s) to send for signature.
341
+
342
+ This endpoint requires either **file** or **file_url[]**, but not both.
343
+ "SignatureRequestSend::FILE_URL": |-
344
+ Use `file_url[]` to have HelloSign download the file(s) to send for signature.
345
+
346
+ This endpoint requires either **file** or **file_url[]**, but not both.
347
+ "SignatureRequestSend::HIDE_TEXT_TAGS": |-
348
+ Enables automatic Text Tag removal when set to true.
349
+
350
+ **NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
351
+ "SignatureRequestSend::IS_QUALIFIED_SIGNATURE": |-
352
+ Send with a value of `true` if you wish to enable
353
+ [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
354
+ which requires a face-to-face call to verify the signer's identity.<br>
355
+ **Note**: QES is only available on the Premium API plan as an add-on purchase.
356
+ Cannot be used in `test_mode`. Only works on requests with one signer.
357
+ "SignatureRequestSend::MESSAGE": The custom message in the email that will be sent to the signers.
358
+ "SignatureRequestSend::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
359
+ "SignatureRequestSend::SUBJECT": The subject in the email that will be sent to the signers.
360
+ "SignatureRequestSend::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
361
+ "SignatureRequestSend::TITLE": The title you want to assign to the SignatureRequest.
362
+ "SignatureRequestSend::USE_PREEXISTING_FIELDS": Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
363
+
364
+ "SignatureRequestSendWithTemplate::SUMMARY": Send with Template
365
+ "SignatureRequestSendWithTemplate::DESCRIPTION": Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.
366
+ "SignatureRequestSendWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
367
+ "SignatureRequestSendWithTemplate::CLIENT_ID": Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
368
+ "SignatureRequestSendWithTemplate::FILE": |-
369
+ Use `file[]` to indicate the uploaded file(s) to send for signature.
370
+
371
+ This endpoint requires either **file** or **file_url[]**, but not both.
372
+ "SignatureRequestSendWithTemplate::FILE_URL": |-
373
+ Use `file_url[]` to have HelloSign download the file(s) to send for signature.
374
+
375
+ This endpoint requires either **file** or **file_url[]**, but not both.
376
+ "SignatureRequestSendWithTemplate::IS_QUALIFIED_SIGNATURE": |-
377
+ Send with a value of `true` if you wish to enable
378
+ [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
379
+ which requires a face-to-face call to verify the signer's identity.<br>
380
+ **Note**: QES is only available on the Premium API plan as an add-on purchase.
381
+ Cannot be used in `test_mode`. Only works on requests with one signer.
382
+ "SignatureRequestSendWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
383
+ "SignatureRequestSendWithTemplate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
384
+ "SignatureRequestSendWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
385
+ "SignatureRequestSendWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
386
+ "SignatureRequestSendWithTemplate::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
387
+ "SignatureRequestSendWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
388
+
389
+ "SignatureRequestUpdate::SUMMARY": Update Signature Request
390
+ "SignatureRequestUpdate::DESCRIPTION": |-
391
+ Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.
392
+
393
+ **NOTE**: This action cannot be performed on a signature request with an appended signature page.
394
+ "SignatureRequestUpdate::EMAIL_ADDRESS": |-
395
+ The new email address for the recipient.
396
+
397
+ **NOTE**: Optional if `name` is provided.
398
+ "SignatureRequestUpdate::NAME": |-
399
+ The new name for the recipient.
400
+
401
+ **NOTE**: Optional if `email_address` is provided.
402
+ "TeamAddMember::TEAM_ID": The id of the team.
403
+ "SignatureRequestUpdate::SIGNATURE_ID": The signature ID for the recipient.
404
+ "SignatureRequestUpdate::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to update.
405
+
406
+ "TeamAddMember::SUMMARY": Add User to Team
407
+ "TeamAddMember::DESCRIPTION": Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a HelloSign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.
408
+ "TeamAddMember::ACCOUNT_ID": |-
409
+ `account_id` or `email_address` is required. If both are provided, the account id prevails.
410
+
411
+ Account id of the user to invite to your Team.
412
+ "TeamAddMember::EMAIL_ADDRESS": |-
413
+ `account_id` or `email_address` is required, If both are provided, the account id prevails.
414
+
415
+ Email address of the user to invite to your Team.
416
+ "TeamAddMember::ROLE": |-
417
+ A role member will take in a new Team.
418
+
419
+ **Note**: This parameter is used only if `team_id` is provided.
420
+
421
+ "TeamCreate::SUMMARY": Create Team
422
+ "TeamCreate::DESCRIPTION": Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.
423
+ "TeamCreate::NAME": The name of your Team.
424
+
425
+ "TeamDelete::SUMMARY": Delete Team
426
+ "TeamDelete::DESCRIPTION": Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).
427
+
428
+ "TeamGet::SUMMARY": Get Team
429
+ "TeamGet::DESCRIPTION": Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.
430
+
431
+ "TeamRemoveMember::SUMMARY": Remove User from Team
432
+ "TeamRemoveMember::DESCRIPTION": Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.
433
+ "TeamRemoveMember::NEW_TEAM_ID": Id of the new Team.
434
+ "TeamRemoveMember::NEW_ROLE": |-
435
+ A new role member will take in a new Team.
436
+
437
+ **Note**: This parameter is used only if `new_team_id` is provided.
438
+ "TeamRemoveMember::ACCOUNT_ID": |-
439
+ **account_id** or **email_address** is required. If both are provided, the account id prevails.
440
+
441
+ Account id to remove from your Team.
442
+ "TeamRemoveMember::EMAIL_ADDRESS": |-
443
+ **account_id** or **email_address** is required. If both are provided, the account id prevails.
444
+
445
+ Email address of the Account to remove from your Team.
446
+ "TeamRemoveMember::NEW_OWNER_EMAIL_ADDRESS": |-
447
+ The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.
448
+
449
+ **Note**: Only available for Enterprise plans.
450
+
451
+ "TeamUpdate::SUMMARY": Update Team
452
+ "TeamUpdate::DESCRIPTION": Updates the name of your Team.
453
+ "TeamUpdate::NAME": The name of your Team.
454
+
455
+ "TeamInfo::SUMMARY": Get Team Info
456
+ "TeamInfo::DESCRIPTION": Provides information about a team.
457
+ "TeamInfo::TEAM_ID": The id of the team.
458
+ "TeamInfo::TEAM_PARENT": Information about the parent team if a team has one, set to `null` otherwise.
459
+
460
+ "TeamMembers::SUMMARY": List Team Members
461
+ "TeamMembers::DESCRIPTION": Provides a paginated list of members (and their roles) that belong to a given team.
462
+ "TeamMembers::TEAM_ID": The id of the team that a member list is being requested from.
463
+ "TeamMembers::PAGE": Which page number of the team member list to return. Defaults to `1`.
464
+ "TeamMembers::PAGE_SIZE": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
465
+
466
+ "TeamMembersResponse::DESCRIPTION": Contains a list of team members and their roles for a specific team.
467
+
468
+ "TeamMemberResponse::ACCOUNT_ID": Account id of the team member.
469
+ "TeamMemberResponse::EMAIL_ADDRESS": Email address of the team member.
470
+ "TeamMemberResponse::MEMBER_ROLE": The specific role a member has on the team.
471
+
472
+ "TeamSubTeams::SUMMARY": List Sub Teams
473
+ "TeamSubTeams::DESCRIPTION": Provides a paginated list of sub teams that belong to a given team.
474
+ "TeamSubTeams::TEAM_ID": The id of the parent Team.
475
+ "TeamSubTeams::PAGE": Which page number of the SubTeam List to return. Defaults to `1`.
476
+ "TeamSubTeams::PAGE_SIZE": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
477
+
478
+ "SubTeamResponse::DESCRIPTION": Contains a list with sub teams.
479
+
480
+ "TemplateAddUser::SUMMARY": Add User to Template
481
+ "TemplateAddUser::DESCRIPTION": Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
482
+ "TemplateAddUser::ACCOUNT_ID": |-
483
+ The id of the Account to give access to the Template.
484
+ <b>Note</b> The account id prevails if email address is also provided.
485
+ "TemplateAddUser::EMAIL_ADDRESS": |-
486
+ The email address of the Account to give access to the Template.
487
+ <b>Note</b> The account id prevails if it is also provided.
488
+ "TemplateAddUser::SKIP_NOTIFICATION": If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.
489
+ "TemplateAddUser::TEMPLATE_ID": The id of the Template to give the Account access to.
490
+
491
+ "TemplateCreateEmbeddedDraft::SUMMARY": Create Embedded Template Draft
492
+ "TemplateCreateEmbeddedDraft::DESCRIPTION": The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
493
+ "TemplateCreateEmbeddedDraft::ALLOW_CCS": This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template.
494
+ "TemplateCreateEmbeddedDraft::ALLOW_REASSIGN": |-
495
+ Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
496
+
497
+ **Note**: Only available for Premium plan and higher.
498
+ "TemplateCreateEmbeddedDraft::CC_ROLES": The CC roles that must be assigned when using the template to send a signature request
499
+ "TemplateCreateEmbeddedDraft::CLIENT_ID": Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.
500
+ "TemplateCreateEmbeddedDraft::FILE": |-
501
+ Use `file[]` to indicate the uploaded file(s) to send for signature.
502
+
503
+ This endpoint requires either **file** or **file_url[]**, but not both.
504
+ "TemplateCreateEmbeddedDraft::FILE_URL": |-
505
+ Use `file_url[]` to have HelloSign download the file(s) to send for signature.
506
+
507
+ This endpoint requires either **file** or **file_url[]**, but not both.
508
+ "TemplateCreateEmbeddedDraft::FORCE_SIGNER_ROLES": Provide users the ability to review/edit the template signer roles.
509
+ "TemplateCreateEmbeddedDraft::FORCE_SUBJECT_MESSAGE": Provide users the ability to review/edit the template subject and message.
510
+ "TemplateCreateEmbeddedDraft::MERGE_FIELDS": |-
511
+ Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter.
512
+ If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.
513
+ "TemplateCreateEmbeddedDraft::MESSAGE": The default template email message.
514
+ "TemplateCreateEmbeddedDraft::SHOW_PREVIEW": |-
515
+ This allows the requester to enable the editor/preview experience.
516
+
517
+ - `show_preview=true`: Allows requesters to enable the editor/preview experience.
518
+ - `show_preview=false`: Allows requesters to disable the editor/preview experience.
519
+ "TemplateCreateEmbeddedDraft::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
520
+ "TemplateCreateEmbeddedDraft::SIGNER_ROLES": An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
521
+ "TemplateCreateEmbeddedDraft::SKIP_ME_NOW": Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
522
+ "TemplateCreateEmbeddedDraft::SUBJECT": The template title (alias).
523
+ "TemplateCreateEmbeddedDraft::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
524
+ "TemplateCreateEmbeddedDraft::TITLE": The title you want to assign to the SignatureRequest.
525
+ "TemplateCreateEmbeddedDraft::USE_PREEXISTING_FIELDS": Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).
526
+
527
+ "TemplateDelete::SUMMARY": Delete Template
528
+ "TemplateDelete::DESCRIPTION": Completely deletes the template specified from the account.
529
+ "TemplateDelete::TEMPLATE_ID": The id of the Template to delete.
530
+
531
+ "TemplateFiles::SUMMARY": Get Template Files
532
+ "TemplateFiles::DESCRIPTION": |-
533
+ Obtain a copy of the current documents specified by the `template_id` parameter.
534
+
535
+ Returns a PDF or ZIP file, or if `get_url` is set, a JSON object with a url to the file (PDFs only). If `get_data_uri` is set, a JSON object with a `data_uri` representing the base64 encoded file (PDFs only) is returned.
536
+
537
+ If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
538
+ "TemplateFiles::FILE_TYPE": Set to `pdf` for a single merged document or `zip` for a collection of individual documents.
539
+ "TemplateFiles::GET_DATA_URI": If `true`, the response will contain the file as base64 encoded string. Base64 encoding is only available for PDFs.
540
+ "TemplateFiles::GET_URL": If `true`, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days.
541
+ "TemplateFiles::TEMPLATE_ID": The id of the template files to retrieve.
542
+
543
+ "TemplateGet::SUMMARY": Get Template
544
+ "TemplateGet::DESCRIPTION": Returns the Template specified by the `template_id` parameter.
545
+ "TemplateGet::TEMPLATE_ID": The id of the Template to retrieve.
546
+
547
+ "TemplateList::SUMMARY": List Templates
548
+ "TemplateList::DESCRIPTION": |-
549
+ Returns a list of the Templates that are accessible by you.
550
+
551
+ Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
552
+ "TemplateList::ACCOUNT_ID": Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.
553
+ "TemplateList::PAGE": Which page number of the Template List to return. Defaults to `1`.
554
+ "TemplateList::PAGE_SIZE": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
555
+ "TemplateList::QUERY": String that includes search terms and/or fields to be used to filter the Template objects.
556
+
557
+ "TemplateRemoveUser::SUMMARY": Remove User from Template
558
+ "TemplateRemoveUser::DESCRIPTION": Removes the specified Account's access to the specified Template.
559
+ "TemplateRemoveUser::ACCOUNT_ID": The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.
560
+ "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.
561
+ "TemplateRemoveUser::TEMPLATE_ID": The id of the Template to remove the Account's access to.
562
+
563
+ "TemplateUpdateFiles::SUMMARY": Update Template Files
564
+ "TemplateUpdateFiles::DESCRIPTION": |-
565
+ Overlays a new file with the overlay of an existing template. The new file(s) must:
566
+
567
+ 1. have the same or higher page count
568
+ 2. the same orientation as the file(s) being replaced.
569
+
570
+ This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota.
571
+
572
+ Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks.
573
+
574
+ It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. 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 and retry the request if necessary.
575
+
576
+ If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
577
+ "TemplateUpdateFiles::CLIENT_ID": Client id of the app you're using to update this template.
578
+ "TemplateUpdateFiles::FILE": |-
579
+ Use `file[]` to indicate the uploaded file(s) to use for the template.
580
+
581
+ This endpoint requires either **file** or **file_url[]**, but not both.
582
+ "TemplateUpdateFiles::FILE_URL": |-
583
+ Use `file_url[]` to have HelloSign download the file(s) to use for the template.
584
+
585
+ This endpoint requires either **file** or **file_url[]**, but not both.
586
+ "TemplateUpdateFiles::MESSAGE": The new default template email message.
587
+ "TemplateUpdateFiles::SUBJECT": The new default template email subject.
588
+ "TemplateUpdateFiles::TEMPLATE_ID": The ID of the template whose files to update.
589
+ "TemplateUpdateFiles::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
590
+
591
+ "UnclaimedDraftCreate::SUMMARY": Create Unclaimed Draft
592
+ "UnclaimedDraftCreate::DESCRIPTION": Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.
593
+ "UnclaimedDraftCreate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
594
+ "UnclaimedDraftCreate::CLIENT_ID": Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
595
+ "UnclaimedDraftCreate::CC_EMAIL_ADDRESSES": The email addresses that should be CCed.
596
+ "UnclaimedDraftCreate::FILE": |-
597
+ Use `file[]` to indicate the uploaded file(s) to send for signature.
598
+
599
+ This endpoint requires either **file** or **file_url[]**, but not both.
600
+ "UnclaimedDraftCreate::FILE_URL": |-
601
+ Use `file_url[]` to have HelloSign download the file(s) to send for signature.
602
+
603
+ This endpoint requires either **file** or **file_url[]**, but not both.
604
+ "UnclaimedDraftCreate::HIDE_TEXT_TAGS": Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
605
+ "UnclaimedDraftCreate::MESSAGE": The custom message in the email that will be sent to the signers.
606
+ "UnclaimedDraftCreate::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
607
+ "UnclaimedDraftCreate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
608
+ "UnclaimedDraftCreate::SUBJECT": The subject in the email that will be sent to the signers.
609
+ "UnclaimedDraftCreate::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
610
+ "UnclaimedDraftCreate::TYPE": The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional.
611
+ "UnclaimedDraftCreate::USE_PREEXISTING_FIELDS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
612
+ "UnclaimedDraftCreate::USE_TEXT_TAGS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
613
+
614
+ "UnclaimedDraftCreateEmbedded::SUMMARY": Create Embedded Unclaimed Draft
615
+ "UnclaimedDraftCreateEmbedded::DESCRIPTION": |-
616
+ Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.
617
+
618
+ **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
619
+ "UnclaimedDraftCreateEmbedded::ALLOW_CCS": This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
620
+ "UnclaimedDraftCreateEmbedded::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
621
+ "UnclaimedDraftCreateEmbedded::ALLOW_REASSIGN": |-
622
+ Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
623
+
624
+ **Note**: Only available for Premium plan and higher.
625
+ "UnclaimedDraftCreateEmbedded::CC_EMAIL_ADDRESSES": The email addresses that should be CCed.
626
+ "UnclaimedDraftCreateEmbedded::CLIENT_ID": Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
627
+ "UnclaimedDraftCreateEmbedded::FILE": |-
628
+ Use `file[]` to indicate the uploaded file(s) to send for signature.
629
+
630
+ This endpoint requires either **file** or **file_url[]**, but not both.
631
+ "UnclaimedDraftCreateEmbedded::FILE_URL": |-
632
+ Use `file_url[]` to have HelloSign download the file(s) to send for signature.
633
+
634
+ This endpoint requires either **file** or **file_url[]**, but not both.
635
+ "UnclaimedDraftCreateEmbedded::FORCE_SIGNER_PAGE": Provide users the ability to review/edit the signers.
636
+ "UnclaimedDraftCreateEmbedded::FORCE_SUBJECT_MESSAGE": Provide users the ability to review/edit the subject and message.
637
+ "UnclaimedDraftCreateEmbedded::HIDE_TEXT_TAGS": Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
638
+ "UnclaimedDraftCreateEmbedded::HOLD_REQUEST": The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
639
+ "UnclaimedDraftCreateEmbedded::IS_FOR_EMBEDDED_SIGNING": The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
640
+ "UnclaimedDraftCreateEmbedded::MESSAGE": The custom message in the email that will be sent to the signers.
641
+ "UnclaimedDraftCreateEmbedded::REQUESTER_EMAIL_ADDRESS": The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.
642
+ "UnclaimedDraftCreateEmbedded::REQUESTING_REDIRECT_URL": The URL you want signers redirected to after they successfully request a signature.
643
+ "UnclaimedDraftCreateEmbedded::SHOW_PREVIEW": |-
644
+ This allows the requester to enable the editor/preview experience.
645
+
646
+ - `show_preview=true`: Allows requesters to enable the editor/preview experience.
647
+ - `show_preview=false`: Allows requesters to disable the editor/preview experience.
648
+ "UnclaimedDraftCreateEmbedded::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
649
+ "UnclaimedDraftCreateEmbedded::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
650
+ "UnclaimedDraftCreateEmbedded::SKIP_ME_NOW": Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
651
+ "UnclaimedDraftCreateEmbedded::SUBJECT": The subject in the email that will be sent to the signers.
652
+ "UnclaimedDraftCreateEmbedded::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
653
+ "UnclaimedDraftCreateEmbedded::TYPE": The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.
654
+ "UnclaimedDraftCreateEmbedded::USE_PREEXISTING_FIELDS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
655
+ "UnclaimedDraftCreateEmbedded::USE_TEXT_TAGS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
656
+ "UnclaimedDraftCreateEmbedded::POPULATE_AUTO_FILL_FIELDS": |-
657
+ Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
658
+
659
+ ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
660
+ "UnclaimedDraftCreateEmbeddedWithTemplate::SUMMARY": Create Embedded Unclaimed Draft with Template
661
+ "UnclaimedDraftCreateEmbeddedWithTemplate::DESCRIPTION": |-
662
+ Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.
663
+
664
+ **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
665
+ "UnclaimedDraftCreateEmbeddedWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
666
+ "UnclaimedDraftCreateEmbeddedWithTemplate::ALLOW_REASSIGN": |-
667
+ Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
668
+
669
+ **Note**: Only available for Premium plan and higher.
670
+ "UnclaimedDraftCreateEmbeddedWithTemplate::CLIENT_ID": Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
671
+ "UnclaimedDraftCreateEmbeddedWithTemplate::FILE": |-
672
+ Use `file[]` to append additional files to the signature request being created from the template. HelloSign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.
673
+
674
+ **file** or **file_url[]** is required, but not both.
675
+ "UnclaimedDraftCreateEmbeddedWithTemplate::FILE_URL": |-
676
+ Use file_url[] to append additional files to the signature request being created from the template. HelloSign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.
677
+
678
+ **file** or **file_url[]** is required, but not both.
679
+ "UnclaimedDraftCreateEmbeddedWithTemplate::FORCE_SIGNER_ROLES": Provide users the ability to review/edit the template signer roles.
680
+ "UnclaimedDraftCreateEmbeddedWithTemplate::FORCE_SUBJECT_MESSAGE": Provide users the ability to review/edit the template subject and message.
681
+ "UnclaimedDraftCreateEmbeddedWithTemplate::HOLD_REQUEST": The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
682
+ "UnclaimedDraftCreateEmbeddedWithTemplate::IS_FOR_EMBEDDED_SIGNING": The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
683
+ "UnclaimedDraftCreateEmbeddedWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
684
+ "UnclaimedDraftCreateEmbeddedWithTemplate::PREVIEW_ONLY": |-
685
+ This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
686
+
687
+ - `preview_only=true`: Allows requesters to enable the preview only experience.
688
+ - `preview_only=false`: Allows requesters to disable the preview only experience.
689
+
690
+ **Note**: This parameter overwrites `show_preview=1` (if set).
691
+ "UnclaimedDraftCreateEmbeddedWithTemplate::REQUESTER_EMAIL_ADDRESS": The email address of the user that should be designated as the requester of this draft.
692
+ "UnclaimedDraftCreateEmbeddedWithTemplate::REQUESTING_REDIRECT_URL": The URL you want signers redirected to after they successfully request a signature.
693
+ "UnclaimedDraftCreateEmbeddedWithTemplate::SHOW_PREVIEW": |-
694
+ This allows the requester to enable the editor/preview experience.
695
+
696
+ - `show_preview=true`: Allows requesters to enable the editor/preview experience.
697
+ - `show_preview=false`: Allows requesters to disable the editor/preview experience.
698
+ "UnclaimedDraftCreateEmbeddedWithTemplate::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
699
+ "UnclaimedDraftCreateEmbeddedWithTemplate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
700
+ "UnclaimedDraftCreateEmbeddedWithTemplate::SKIP_ME_NOW": Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
701
+ "UnclaimedDraftCreateEmbeddedWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
702
+ "UnclaimedDraftCreateEmbeddedWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.
703
+ "UnclaimedDraftCreateEmbeddedWithTemplate::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
704
+ "UnclaimedDraftCreateEmbeddedWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
705
+ "UnclaimedDraftCreateEmbeddedWithTemplate::POPULATE_AUTO_FILL_FIELDS": |-
706
+ Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
707
+
708
+ ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
709
+ "UnclaimedDraftEditAndResend::SUMMARY": Edit and Resend Unclaimed Draft
710
+ "UnclaimedDraftEditAndResend::DESCRIPTION": |-
711
+ Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set.
712
+
713
+ **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
714
+ "UnclaimedDraftEditAndResend::REQUESTER_EMAIL_ADDRESS": The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used.
715
+ "UnclaimedDraftEditAndResend::SIGNATURE_REQUEST_ID": The ID of the signature request to edit and resend.
716
+ "UnclaimedDraftEditAndResend::CLIENT_ID": Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
717
+ "UnclaimedDraftEditAndResend::IS_FOR_EMBEDDED_SIGNING": The request created from this draft will also be signable in embedded mode if set to `true`.
718
+ "UnclaimedDraftEditAndResend::REQUESTING_REDIRECT_URL": The URL you want signers redirected to after they successfully request a signature.
719
+ "UnclaimedDraftEditAndResend::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
720
+ "UnclaimedDraftEditAndResend::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
721
+ "UnclaimedDraftEditAndResend::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
722
+
723
+ "Sub::Attachment::INSTRUCTIONS": The instructions for uploading the attachment.
724
+ "Sub::Attachment::NAME": The name of attachment.
725
+ "Sub::Attachment::REQUIRED": Determines if the attachment must be uploaded.
726
+ "Sub::Attachment::SIGNER_INDEX": |-
727
+ The signer's index in the `signers` parameter (0-based indexing).
728
+
729
+ **NOTE**: Only one signer can be assigned per attachment.
730
+
731
+ "Sub::BulkCustomField::DESCRIPTION": An array of custom field values.
732
+ "Sub::BulkCustomField::NAME": The name of the custom field. Must be the field's `name` or `api_id`.
733
+ "Sub::BulkCustomField::VALUE": The value of the custom field.
734
+
735
+ "Sub::BulkSigner::DESCRIPTION": |-
736
+ Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
737
+
738
+ Currently only templates with a single role are supported. All signers must have the same `role` value.
739
+
740
+ "Sub::CC::DESCRIPTION": Add CC email recipients. Required when a CC role exists for the Template.
741
+ "Sub::CC::EMAIL_ADDRESS": The email address of the CC recipient.
742
+ "Sub::CC::ROLE": Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role.
743
+
744
+ "Sub::CustomField::DESCRIPTION": |-
745
+ When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
746
+
747
+ Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
748
+
749
+ For using pre-filled on repeatable signature requests, merge fields are added to templates in the HelloSign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
750
+ "Sub::CustomField::EDITOR": |-
751
+ Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.
752
+
753
+ **Note**: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
754
+ "Sub::CustomField::NAME": The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing.
755
+ "Sub::CustomField::REQUIRED": Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.
756
+ "Sub::CustomField::TEMPLATE": An array defining values and options for custom fields. Required when a custom field exists in the Template.
757
+ "Sub::CustomField::VALUE": The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing.
758
+
759
+ "Sub::EditorOptions::DESCRIPTION": This allows the requester to specify editor options when a preparing a document
760
+ "Sub::EditorOptions::ALLOW_EDIT_DOCUMENTS": Allows requesters to edit documents, including delete and add
761
+ "Sub::EditorOptions::ALLOW_EDIT_SIGNERS": Allows requesters to edit the list of signers
762
+
763
+ "Sub::FieldOptions::DESCRIPTION": This allows the requester to specify field options for a signature request.
764
+ "Sub::FieldOptions::DATE_FORMAT": |-
765
+ Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))
766
+
767
+ **Note**: Only available for Premium and higher.
768
+
769
+ "Sub::FormFieldGroup::DESCRIPTION": Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
770
+ "Sub::FormFieldGroup::GROUP_ID_LABEL": ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`.
771
+ "Sub::FormFieldGroup::GROUP_LABEL": Name of the group
772
+ "Sub::FormFieldGroup::REQUIREMENT": |-
773
+ Examples: `require_0-1` `require_1` `require_1-ormore`
774
+
775
+ - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping).
776
+ - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping).
777
+ - Radio groups require **at least** two fields per group.
778
+
779
+ "Sub::FormFieldRule::DESCRIPTION": Conditional Logic rules for fields defined in `form_fields_per_document`.
780
+ "Sub::FormFieldRule::ID": Must be unique across all defined rules.
781
+ "Sub::FormFieldRule::TRIGGER_OPERATOR": Currently only `AND` is supported. Support for `OR` is being worked on.
782
+
783
+ "Sub::FormFieldRuleAction::DESCRIPTION": An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule.
784
+ "Sub::FormFieldRuleAction::FIELD_ID": |-
785
+ **field_id** or **group_id** is required, but not both.
786
+
787
+ Must reference the `api_id` of an existing field defined within `form_fields_per_document`.
788
+
789
+ Cannot use with `group_id`. Trigger and action fields must belong to the same signer.
790
+ "Sub::FormFieldRuleAction::GROUP_ID": |-
791
+ **group_id** or **field_id** is required, but not both.
792
+
793
+ Must reference the ID of an existing group defined within `form_field_groups`.
794
+
795
+ Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer.
796
+ "Sub::FormFieldRuleAction::HIDDEN": "`true` to hide the target field when rule is satisfied, otherwise `false`."
797
+ "Sub::FormFieldRuleAction::TYPE": |-
798
+ - `change-field-visibility` if `field_id` used.
799
+ - `change-group-visibility` if `group_id` used.
800
+
801
+ "Sub::FormFieldRuleTrigger::DESCRIPTION": An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed.
802
+ "Sub::FormFieldRuleTrigger::ID": Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer.
803
+ "Sub::FormFieldRuleTrigger::OPERATOR": |-
804
+ Different field types allow different `operator` values:
805
+ - Field type of **text**:
806
+ - **is**: exact match
807
+ - **not**: not exact match
808
+ - **match**: regular expression, without /. Example:
809
+ - OK `[a-zA-Z0-9]`
810
+ - Not OK `/[a-zA-Z0-9]/`
811
+ - Field type of **dropdown**:
812
+ - **is**: exact match, single value
813
+ - **not**: not exact match, single value
814
+ - **any**: exact match, array of values.
815
+ - **none**: not exact match, array of values.
816
+ - Field type of **checkbox**:
817
+ - **is**: exact match, single value
818
+ - **not**: not exact match, single value
819
+ - Field type of **radio**:
820
+ - **is**: exact match, single value
821
+ - **not**: not exact match, single value
822
+ "Sub::FormFieldRuleTrigger::VALUE_SINGLE": |-
823
+ **value** or **values** is required, but not both.
824
+
825
+ The value to match against **operator**.
826
+
827
+ - When **operator** is one of the following, **value** must be `String`:
828
+ - `is`
829
+ - `not`
830
+ - `match`
831
+
832
+ Otherwise,
833
+ - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1`
834
+ - **radio**: When **type** of trigger is **radio**, **value** must be `1`
835
+ "Sub::FormFieldRuleTrigger::VALUE_MULTI": |-
836
+ **values** or **value** is required, but not both.
837
+
838
+ The values to match against **operator** when it is one of the following:
839
+
840
+ - `any`
841
+ - `none`
842
+
843
+ "Sub::FormFieldsPerDocument::DESCRIPTION": |-
844
+ The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/placing-fields/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
845
+
846
+ **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
847
+
848
+ * Text Field use `SubFormFieldsPerDocumentText`
849
+ * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
850
+ * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
851
+ * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
852
+ * Radio Field use `SubFormFieldsPerDocumentRadio`
853
+ * Signature Field use `SubFormFieldsPerDocumentSignature`
854
+ * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
855
+ * Initials Field use `SubFormFieldsPerDocumentInitials`
856
+ * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
857
+ * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
858
+ "Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS": This class extends `SubFormFieldsPerDocumentBase`.
859
+ "Sub::FormFieldsPerDocument::API_ID": An identifier for the field that is unique across all documents in the request.
860
+ "Sub::FormFieldsPerDocument::AUTO_FILL_TYPE": Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.
861
+ "Sub::FormFieldsPerDocument::LINK_ID": Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.
862
+ "Sub::FormFieldsPerDocument::IS_CHECKED_CHECKBOX": "`true` for checking the checkbox field by default, otherwise `false`."
863
+ "Sub::FormFieldsPerDocument::IS_CHECKED_RADIO": "`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`."
864
+ "Sub::FormFieldsPerDocument::CONTENT_DROPDOWN": Selected value in `options` array. Value must exist in array.
865
+ "Sub::FormFieldsPerDocument::CONTENT_HYPERLINK": Link Text.
866
+ "Sub::FormFieldsPerDocument::CONTENT_URL": Link URL.
867
+ "Sub::FormFieldsPerDocument::DOCUMENT_INDEX": Represents the integer index of the `file` or `file_url` document the field should be attached to.
868
+ "Sub::FormFieldsPerDocument::GROUP": String referencing group defined in `form_field_groups` parameter.
869
+ "Sub::FormFieldsPerDocument::HEIGHT": Size of the field in pixels.
870
+ "Sub::FormFieldsPerDocument::MASKED": Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.
871
+ "Sub::FormFieldsPerDocument::NAME": Display name for the field.
872
+ "Sub::FormFieldsPerDocument::OPTIONS": Array of string values representing dropdown values.
873
+ "Sub::FormFieldsPerDocument::PAGE": |-
874
+ Page in the document where the field should be placed (requires documents be PDF files).
875
+
876
+ - When the page number parameter is supplied, the API will use the new coordinate system.
877
+ - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.
878
+ "Sub::FormFieldsPerDocument::PLACEHOLDER": Placeholder value for text field.
879
+ "Sub::FormFieldsPerDocument::REQUIRED": Whether this field is required.
880
+ "Sub::FormFieldsPerDocument::SIGNER": |-
881
+ Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
882
+
883
+ **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
884
+ "Sub::FormFieldsPerDocument::TYPE": One of the [Type](/api/reference/constants/#field-types) options.
885
+ "Sub::FormFieldsPerDocument::TYPE_CHECKBOX": A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.
886
+ "Sub::FormFieldsPerDocument::TYPE_CHECKBOX_MERGE": A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.
887
+ "Sub::FormFieldsPerDocument::TYPE_DATE_SIGNED": A date. Use the `SubFormFieldsPerDocumentDateSigned` class.
888
+ "Sub::FormFieldsPerDocument::TYPE_DROPDOWN": An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.
889
+ "Sub::FormFieldsPerDocument::TYPE_HYPERLINK": A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.
890
+ "Sub::FormFieldsPerDocument::TYPE_INITIALS": An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.
891
+ "Sub::FormFieldsPerDocument::TYPE_RADIO": An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.
892
+ "Sub::FormFieldsPerDocument::TYPE_SIGNATURE": A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.
893
+ "Sub::FormFieldsPerDocument::TYPE_TEXT": A text input field. Use the `SubFormFieldsPerDocumentText` class.
894
+ "Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE": A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.
895
+ "Sub::FormFieldsPerDocument::VALIDATION_TYPE": |-
896
+ Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.
897
+
898
+ **NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
899
+ "Sub::FormFieldsPerDocument::WIDTH": Size of the field in pixels.
900
+ "Sub::FormFieldsPerDocument::X": Location coordinates of the field in pixels.
901
+ "Sub::FormFieldsPerDocument::Y": Location coordinates of the field in pixels.
902
+
903
+ "Sub::MergeField::NAME": The name of the merge field. Must be unique.
904
+ "Sub::MergeField::TYPE": The type of merge field.
905
+ "Sub::MergeField::EnumDescriptions::TEXT": Sets merge [field type](/api/reference/constants/#field-types) to `text`.
906
+ "Sub::MergeField::EnumDescriptions::CHECKBOX": Sets merge [field type](/api/reference/constants/#field-types) to `checkbox`.
907
+
908
+
909
+ "Sub::Metadata::DESCRIPTION": |-
910
+ Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
911
+
912
+ Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
913
+
914
+ "Sub::OAuth::CALLBACK_URL": The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)
915
+ "Sub::OAuth::DESCRIPTION": OAuth related parameters.
916
+ "Sub::OAuth::SCOPES": A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided).
917
+
918
+ "Sub::Options::CAN_INSERT_EVERYWHERE": Determines if signers can use "Insert Everywhere" when signing a document.
919
+ "Sub::Options::DESCRIPTION": Additional options supported by API App.
920
+
921
+ "Sub::SignatureRequestSigner::DESCRIPTION": Add Signers to your Signature Request.
922
+ "Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS": The email address of the signer.
923
+ "Sub::SignatureRequestSigner::SIGNER_NAME": The name of the signer.
924
+ "Sub::SignatureRequestSigner::SIGNER_ORDER": The order the signer is required to sign in.
925
+ "Sub::SignatureRequestSigner::SIGNER_PIN": The 4- to 12-character access code that will secure this signer's signature page.
926
+ "Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER": |-
927
+ An E.164 formatted phone number.
928
+
929
+ **Note**: Not available in test mode and requires a Standard plan or higher.
930
+
931
+ "Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE": |-
932
+ Specifies the feature used with the `sms_phone_number`. Default `authentication`.
933
+
934
+ If `authentication`, signer is sent a verification code via SMS that is required to access the document.
935
+
936
+ If `delivery`, the completed signature request is delivered via SMS (_and_ email).
937
+
938
+ "Sub::SignatureRequestTemplateSigner::DESCRIPTION": Add Signers to your Templated-based Signature Request.
939
+ "Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS": The email address of the signer.
940
+ "Sub::SignatureRequestTemplateSigner::NAME": The name of the signer.
941
+ "Sub::SignatureRequestTemplateSigner::PIN": The 4- to 12-character access code that will secure this signer's signature page.
942
+ "Sub::SignatureRequestTemplateSigner::ROLE": Must match an existing role in chosen Template(s). It's case-sensitive.
943
+ "Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER": |-
944
+ An E.164 formatted phone number.
945
+
946
+ **Note**: Not available in test mode and requires a Standard plan or higher.
947
+
948
+ "Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE": |-
949
+ Specifies the feature used with the `sms_phone_number`. Default `authentication`.
950
+
951
+ If `authentication`, signer is sent a verification code via SMS that is required to access the document.
952
+
953
+ If `delivery`, the completed signature request is delivered via SMS (_and_ email).
954
+
955
+ "Sub::SignerRole::NAME": The role name of the signer that will be displayed when the template is used to create a signature request.
956
+ "Sub::SignerRole::ORDER": The order in which this signer role is required to sign.
957
+
958
+ "Sub::SigningOptions::DESCRIPTION": |-
959
+ This allows the requester to specify the types allowed for creating a signature.
960
+
961
+ **Note**: If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
962
+ "Sub::SigningOptions::DEFAULT": The default type shown (limited to the listed types)
963
+ "Sub::SigningOptions::DRAW": Allows drawing the signature
964
+ "Sub::SigningOptions::PHONE": Allows using a smartphone to email the signature
965
+ "Sub::SigningOptions::TYPE": Allows typing the signature
966
+ "Sub::SigningOptions::UPLOAD": Allows uploading the signature
967
+
968
+ "Sub::UnclaimedDraftSigner::DESCRIPTION": Add Signers to your Unclaimed Draft Signature Request.
969
+ "Sub::UnclaimedDraftSigner::EMAIL_ADDRESS": The email address of the signer.
970
+ "Sub::UnclaimedDraftSigner::NAME": The name of the signer.
971
+ "Sub::UnclaimedDraftSigner::ORDER": The order the signer is required to sign in.
972
+
973
+ "Sub::UnclaimedDraftTemplateSigner::DESCRIPTION": Add Signers to your Templated-based Signature Request.
974
+ "Sub::UnclaimedDraftTemplateSigner::ROLE": Must match an existing role in chosen Template(s).
975
+ "Sub::UnclaimedDraftTemplateSigner::NAME": The name of the signer filling the role of `role`.
976
+ "Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS": The email address of the signer filling the role of `role`.
977
+
978
+ "Sub::WhiteLabelingOptions::DESCRIPTION": |-
979
+ An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans)
980
+
981
+ Take a look at our [white labeling guide](/api/reference/white-labeling/) to learn more.
982
+ "Sub::WhiteLabelingOptions::RESET_TO_DEFAULT": Resets white labeling options to defaults. Only useful when updating an API App.
983
+
984
+ ###################
985
+ # Response Models #
986
+ ###################
987
+
988
+ "AccountCreateResponseExample::SUMMARY": Account Create
989
+ "AccountGetResponseExample::SUMMARY": Account Get
990
+ "AccountCreateOAuthResponseExample::SUMMARY": Account Create with OAuth Authorization
991
+ "AccountUpdateResponseExample::SUMMARY": Account Update
992
+ "AccountVerifyFoundResponseExample::SUMMARY": Account Found
993
+ "AccountVerifyNotFoundResponseExample::SUMMARY": Account Not Found
994
+ "AccountResponse::DESCRIPTION": Contains the Account information
995
+ "AccountVerifyResponse::DESCRIPTION": Contains the verified Account's information.
996
+ "Account::ACCOUNT_ID": The ID of the Account
997
+ "Account::EMAIL_ADDRESS": The email address associated with the Account.
998
+ "Account::CALLBACK_URL": The URL that HelloSign events will `POST` to.
999
+ "Account::IS_LOCKED": Returns `true` if the user has been locked out of their account by a team admin.
1000
+ "Account::IS_PAID_HS": Returns `true` if the user has a paid HelloSign account.
1001
+ "Account::IS_PAID_HF": Returns `true` if the user has a paid HelloFax account.
1002
+ "Account::ROLE_CODE": The membership role for the team.
1003
+ "Account::LOCALE": The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
1004
+ "Account::QUOTA": Details concerning remaining monthly quotas.
1005
+ "AccountQuota::TEMPLATES_LEFT": API templates remaining.
1006
+ "AccountQuota::API_SIGNATURE_REQUESTS_LEFT": API signature requests remaining.
1007
+ "AccountQuota::DOCUMENTS_LEFT": Signature requests remaining.
1008
+ "AccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining.
1009
+
1010
+ "ApiAppCreateResponseExample::SUMMARY": API App
1011
+ "ApiAppGetResponseExample::SUMMARY": API App
1012
+ "ApiAppListResponseExample::SUMMARY": API App List
1013
+ "ApiAppUpdateResponseExample::SUMMARY": API App Update
1014
+ "ApiAppResponse::CALLBACK_URL": The app's callback URL (for events)
1015
+ "ApiAppResponse::CLIENT_ID": The app's client id
1016
+ "ApiAppResponse::DESCRIPTION": Contains information about an API App.
1017
+ "ApiAppResponse::CREATED_AT": The time that the app was created
1018
+ "ApiAppResponse::DOMAINS": The domain name(s) associated with the app
1019
+ "ApiAppResponse::NAME": The name of the app
1020
+ "ApiAppResponse::IS_APPROVED": Boolean to indicate if the app has been approved
1021
+
1022
+ "ApiAppListResponse::DESCRIPTION": Contains information about API Apps.
1023
+
1024
+ "ApiAppResponseOAuth::DESCRIPTION": An object describing the app's OAuth properties, or null if OAuth is not configured for the app.
1025
+ "ApiAppResponseOAuth::CALLBACK_URL": The app's OAuth callback URL.
1026
+ "ApiAppResponseOAuth::CHARGES_USERS": Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.
1027
+ "ApiAppResponseOAuth::SECRET": The app's OAuth secret, or null if the app does not belong to user.
1028
+ "ApiAppResponseOAuth::SCOPES": Array of OAuth scopes used by the app.
1029
+
1030
+ "ApiAppResponseOptions::DESCRIPTION": An object with options that override account settings.
1031
+ "ApiAppResponseOptions::CAN_INSERT_EVERYWHERE": Boolean denoting if signers can "Insert Everywhere" in one click while signing a document
1032
+
1033
+ "ApiAppResponseOwnerAccount::DESCRIPTION": An object describing the app's owner
1034
+ "ApiAppResponseOwnerAccount::ACCOUNT_ID": The owner account's ID
1035
+ "ApiAppResponseOwnerAccount::EMAIL_ADDRESS": The owner account's email address
1036
+
1037
+ "ApiAppResponseWhiteLabelingOptions::DESCRIPTION": An object with options to customize the app's signer page
1038
+
1039
+ "BulkSendJobGetResponseExample::SUMMARY": Bulk Send Job
1040
+ "BulkSendJobListResponseExample::SUMMARY": Bulk Send Job List
1041
+ "BulkSendJobListResponse::BULK_SEND_JOBS": Contains a list of BulkSendJobs that the API caller has access to.
1042
+ "BulkSendJobResponse::BULK_SEND_JOB_ID": The id of the BulkSendJob.
1043
+ "BulkSendJobResponse::DESCRIPTION": Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.
1044
+ "BulkSendJobResponse::TOTAL": The total amount of Signature Requests queued for sending.
1045
+ "BulkSendJobResponse::IS_CREATOR": True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.
1046
+ "BulkSendJobResponse::CREATED_AT": Time that the BulkSendJob was created.
1047
+ "BulkSendJobGetResponse::SIGNATURE_REQUESTS": Contains information about the Signature Requests sent in bulk.
1048
+ "BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID": The id of the BulkSendJob.
1049
+
1050
+ "Common::RateLimiting::LIMIT": The maximum number of requests per hour that you can make.
1051
+ "Common::RateLimiting::REMAINING": The number of requests remaining in the current rate limit window.
1052
+ "Common::RateLimiting::RESET": The Unix time at which the rate limit will reset to its maximum.
1053
+
1054
+ "EmbeddedEditUrlResponseExample::SUMMARY": Embedded Edit URL
1055
+ "EmbeddedSignUrlResponseExample::SUMMARY": Embedded Sign URL
1056
+
1057
+ "EmbeddedSignUrlResponseEmbedded::DESCRIPTION": An object that contains necessary information to set up embedded signing.
1058
+ "EmbeddedSignUrlResponseEmbedded::SIGN_URL": A signature url that can be opened in an iFrame.
1059
+ "EmbeddedSignUrlResponseEmbedded::EXPIRES_AT": The specific time that the the `sign_url` link expires, in epoch.
1060
+
1061
+ "EmbeddedEditUrlResponseEmbedded::DESCRIPTION": An embedded template object.
1062
+ "EmbeddedEditUrlResponseEmbedded::EDIT_URL": A template url that can be opened in an iFrame.
1063
+ "EmbeddedEditUrlResponseEmbedded::EXPIRES_AT": The specific time that the the `edit_url` link expires, in epoch.
1064
+
1065
+ "EventCallbackAccountRequest::DESCRIPTION": |-
1066
+ **Account Callback Payloads --**
1067
+ Events that are reported at the Account level through the the *Account callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api). The *Account callback URL* can also be updated by calling [Update Account](/api/reference/operation/accountUpdate) and passing a `callback_url`.
1068
+ "EventCallbackAccountSignatureRequestSentExample::SUMMARY": |-
1069
+ Example: signature_request_sent
1070
+ "EventCallbackAccountTemplateCreatedExample::SUMMARY": |-
1071
+ Example: template_created
1072
+ "EventCallbackApiAppAccountConfirmedExample::SUMMARY": |-
1073
+ Example: account_confirmed
1074
+ "EventCallbackApiAppSignatureRequestSentExample::SUMMARY": |-
1075
+ Example: signature_request_sent
1076
+ "EventCallbackApiAppTemplateCreatedExample::SUMMARY": |-
1077
+ Example: template_created
1078
+ "EventCallbackApiAppRequest::DESCRIPTION": |-
1079
+ **API App Callback Payloads --**
1080
+ Events that are reported at the API App level through the *Event callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api) for a specific app. The *Event callback URL* can also be updated by calling [Update API App](/api/reference/operation/apiAppUpdate) and passing a `callback_url`.
1081
+ "EventCallbackRequestEvent::DESCRIPTION": Basic information about the event that occurred.
1082
+ "EventCallbackRequestEvent::EVENT_TIME": Time the event was created (using Unix time).
1083
+ "EventCallbackRequestEvent::EVENT_TYPE": Type of callback event that was triggered.
1084
+ "EventCallbackRequestEvent::EVENT_HASH": Generated hash used to verify source of event data.
1085
+ "EventCallbackRequestEventMetadata::DESCRIPTION": Specific metadata about the event.
1086
+ "EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID": Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.
1087
+ "EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID": Account ID the event was reported for.
1088
+ "EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID": App ID the event was reported for.
1089
+ "EventCallbackRequestEventMetadata::EVENT_MESSAGE": Message about a declined or failed (due to error) signature flow.
1090
+ "EventCallbackSignatureRequestExample::SUMMARY": Event Callback Signature Request Example
1091
+ "EventCallbackTemplateRequestExample::SUMMARY": Event Callback Template Example
1092
+
1093
+ "ListInfoResponse::DESCRIPTION": Contains pagination information about the data returned.
1094
+ "ListInfoResponse::NUM_PAGES": Total number of pages available.
1095
+ "ListInfoResponse::NUM_RESULTS": Total number of objects available.
1096
+ "ListInfoResponse::PAGE": Number of the page being returned.
1097
+ "ListInfoResponse::PAGE_SIZE": Objects returned per page.
1098
+
1099
+ "WarningResponse::LIST_DESCRIPTION": A list of warnings.
1100
+ "WarningResponse::WARNING_MSG": Warning message
1101
+ "WarningResponse::WARNING_NAME": Warning name
1102
+
1103
+ "SubAttachment::LIST_DESCRIPTION": A list describing the attachments
1104
+
1105
+ "OAuthTokenGenerateResponseExample::SUMMARY": Retrieving the OAuth token
1106
+ "OAuthTokenRefreshResponseExample::SUMMARY": Refresh an existing OAuth token
1107
+ "OAuthTokenResponse::ACCESS_TOKEN": The access token used for sending API calls on behalf of the user that authorized the API App.
1108
+ "OAuthTokenResponse::TOKEN_TYPE": The authorization method used with the token. Passed in the `Authorization` header of the HTTP request as `Bearer <hs-oauth-access-token>`.
1109
+ "OAuthTokenResponse::REFRESH_TOKEN": The long-lived refresh token used to refresh an expired `access_token` without forcing the user through another OAuth approval flow (unless the apps `access_scope` has changed or the user revoked their authorization).
1110
+ "OAuthTokenResponse::EXPIRES_IN": Number of seconds until the `access_token` expires. Uses epoch time.
1111
+ "OAuthTokenResponse::STATE": The string that was passed back with `state` during the initial authorization step.
1112
+
1113
+ "ReportCreateResponseExample::SUMMARY": Report
1114
+ "ReportResponse::DESCRIPTION": Contains information about the report request.
1115
+ "ReportResponse::END_DATE": The (inclusive) end date for the report data in MM/DD/YYYY format.
1116
+ "ReportResponse::REPORT_TYPE": The type(s) of the report you are requesting. Allowed values are "user_activity" and "document_status". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).
1117
+ "ReportResponse::START_DATE": The (inclusive) start date for the report data in MM/DD/YYYY format.
1118
+ "ReportResponse::SUCCESS": A message indicating the requested operation's success
1119
+
1120
+ "SignatureRequestCreateEmbeddedResponseExample::SUMMARY": Create Embedded Signature Request
1121
+ "SignatureRequestCreateEmbeddedWithTemplateResponseExample::SUMMARY": Create Embedded Signature Request With Template
1122
+ "SignatureRequestGetResponseExample::SUMMARY": Get Signature Request
1123
+ "SignatureRequestFilesResponseExample::SUMMARY": Signature Requests Files
1124
+ "SignatureRequestListResponseExample::SUMMARY": List Signature Requests
1125
+ "SignatureRequestReleaseHoldResponseExample::SUMMARY": Send Signature Release Hold
1126
+ "SignatureRequestRemindResponseExample::SUMMARY": Send Signature Request Reminder
1127
+ "SignatureRequestSendResponseExample::SUMMARY": Send Signature Request
1128
+ "SignatureRequestSendWithTemplateResponseExample::SUMMARY": Send Signature Request With Template
1129
+ "SignatureRequestBulkSendWithTemplateResponseExample::SUMMARY": Send Signature Request With Template
1130
+ "SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample::SUMMARY": Bulk Send Create Embedded Signature Request With Template
1131
+ "SignatureRequestUpdateResponseExample::SUMMARY": Signature Request Update
1132
+
1133
+ "SignatureRequestResponse::CC_EMAIL_ADDRESSES": A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
1134
+ "SignatureRequestResponse::CREATED_AT": Time the signature request was created.
1135
+ "SignatureRequestResponse::DESCRIPTION": Contains information about a signature request.
1136
+ "SignatureRequestResponse::DETAILS_URL": The URL where the requester and the signers can view the current status of the SignatureRequest.
1137
+ "SignatureRequestResponse::FILES_URL": The URL where a copy of the request's documents can be downloaded.
1138
+ "SignatureRequestResponse::HAS_ERROR": Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
1139
+ "SignatureRequestResponse::IS_COMPLETE": Whether or not the SignatureRequest has been fully executed by all signers.
1140
+ "SignatureRequestResponse::IS_DECLINED": Whether or not the SignatureRequest has been declined by a signer.
1141
+ "SignatureRequestResponse::MESSAGE": The custom message in the email that was initially sent to the signers.
1142
+ "SignatureRequestResponse::METADATA": The metadata attached to the signature request.
1143
+ "SignatureRequestResponse::ORIGINAL_TITLE": Default Label for account.
1144
+ "SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS": The email address of the initiator of the SignatureRequest.
1145
+ "SignatureRequestResponse::SIGNATURE_REQUEST_ID": The id of the SignatureRequest.
1146
+ "SignatureRequestResponse::SIGNING_REDIRECT_URL": The URL you want the signer redirected to after they successfully sign.
1147
+ "SignatureRequestResponse::SIGNING_URL": The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing HelloSign accounts as they will be required to log in before signing.
1148
+ "SignatureRequestResponse::SUBJECT": The subject in the email that was initially sent to the signers.
1149
+ "SignatureRequestResponse::TEMPLATE_IDS": Templates IDs used in this SignatureRequest (if any).
1150
+ "SignatureRequestResponse::TEST_MODE": Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
1151
+ "SignatureRequestResponse::TITLE": The title the specified Account uses for the SignatureRequest.
1152
+
1153
+ "SignatureRequestListResponse::DESCRIPTION": Contains information about signature requests.
1154
+
1155
+ "SignatureRequestResponseCustomField::DESCRIPTION": |-
1156
+ An array of Custom Field objects containing the name and type of each custom field.
1157
+
1158
+ * Text Field uses `SignatureRequestResponseCustomFieldText`
1159
+ * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`
1160
+ "SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS": This class extends `SignatureRequestResponseCustomFieldBase`.
1161
+ "SignatureRequestResponseCustomField::API_ID": The unique ID for this field.
1162
+ "SignatureRequestResponseCustomField::EDITOR": The name of the Role that is able to edit this field.
1163
+ "SignatureRequestResponseCustomField::NAME": The name of the Custom Field.
1164
+ "SignatureRequestResponseCustomField::REQUIRED": A boolean value denoting if this field is required.
1165
+ "SignatureRequestResponseCustomField::TYPE": The type of this Custom Field. Only 'text' and 'checkbox' are currently supported.
1166
+ "SignatureRequestResponseCustomField::VALUE_TEXT": A text string for text fields
1167
+ "SignatureRequestResponseCustomField::VALUE_CHECKBOX": A true/false for checkbox fields
1168
+
1169
+ "SignatureRequestResponseAttachment::DESCRIPTION": Signer attachments.
1170
+ "SignatureRequestResponseAttachment::ID": The unique ID for this attachment.
1171
+ "SignatureRequestResponseAttachment::SIGNER": The Signer this attachment is assigned to.
1172
+ "SignatureRequestResponseAttachment::NAME": The name of this attachment.
1173
+ "SignatureRequestResponseAttachment::INSTRUCTIONS": Instructions for Signer.
1174
+ "SignatureRequestResponseAttachment::REQUIRED": A boolean value denoting if this attachment is required.
1175
+ "SignatureRequestResponseAttachment::UPLOADED_AT": Timestamp when attachment was uploaded by Signer.
1176
+
1177
+ "SignatureRequestResponseData::DESCRIPTION": An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
1178
+ "SignatureRequestResponseData::API_ID": The unique ID for this field.
1179
+ "SignatureRequestResponseData::NAME": The name of the form field.
1180
+ "SignatureRequestResponseData::REQUIRED": A boolean value denoting if this field is required.
1181
+ "SignatureRequestResponseData::SIGNATURE_ID": The ID of the signature to which this response is linked.
1182
+ "SignatureRequestResponseDataValue::TEXT_TYPE": A text input field
1183
+ "SignatureRequestResponseDataValue::CHECKBOX_TYPE": A yes/no checkbox
1184
+ "SignatureRequestResponseDataValue::DATESIGNED_TYPE": A date
1185
+ "SignatureRequestResponseDataValue::DROPDOWN_TYPE": An input field for dropdowns
1186
+ "SignatureRequestResponseDataValue::INITIAL_TYPE": An input field for initials
1187
+ "SignatureRequestResponseDataValue::RADIO_TYPE": An input field for radios
1188
+ "SignatureRequestResponseDataValue::SIGNATURE_TYPE": A signature input field
1189
+ "SignatureRequestResponseDataValue::TEXTMERGE_TYPE": A text field that has default text set by the api
1190
+ "SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE": A checkbox field that has default value set by the api
1191
+ "SignatureRequestResponseDataValue::VALUE": The value of the form field.
1192
+
1193
+ "SignatureRequestResponseSignatures::DESCRIPTION": An array of signature objects, 1 for each signer.
1194
+ "SignatureRequestResponseSignatures::DECLINE_REASON": The reason provided by the signer for declining the request.
1195
+ "SignatureRequestResponseSignatures::ERROR": Error message pertaining to this signer, or null.
1196
+ "SignatureRequestResponseSignatures::HAS_PIN": Boolean to indicate whether this signature requires a PIN to access.
1197
+ "SignatureRequestResponseSignatures::HAS_SMS_AUTH": Boolean to indicate whether this signature has SMS authentication enabled.
1198
+ "SignatureRequestResponseSignatures::HAS_SMS_DELIVERY": Boolean to indicate whether this signature has SMS delivery enabled.
1199
+ "SignatureRequestResponseSignatures::SMS_PHONE_NUMBER": The SMS phone number used for authentication or signature request delivery.
1200
+ "SignatureRequestResponseSignatures::LAST_VIEWED_AT": The time that the document was last viewed by this signer or null.
1201
+ "SignatureRequestResponseSignatures::LAST_REMINDED_AT": The time the last reminder email was sent to the signer or null.
1202
+ "SignatureRequestResponseSignatures::NUM_PAGES": Total number of pages available
1203
+ "SignatureRequestResponseSignatures::ORDER": If signer order is assigned this is the 0-based index for this signer.
1204
+ "SignatureRequestResponseSignatures::REASSIGNED_BY": Email address of original signer who reassigned to this signer.
1205
+ "SignatureRequestResponseSignatures::REASSIGNMENT_REASON": Reason provided by original signer who reassigned to this signer.
1206
+ "SignatureRequestResponseSignatures::SIGNATURE_ID": Signature identifier.
1207
+ "SignatureRequestResponseSignatures::SIGNED_AT": Time that the document was signed or null.
1208
+ "SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS": The email address of the signer.
1209
+ "SignatureRequestResponseSignatures::SIGNER_NAME": The name of the signer.
1210
+ "SignatureRequestResponseSignatures::SIGNER_ROLE": The role of the signer.
1211
+ "SignatureRequestResponseSignatures::STATUS_CODE": "The current status of the signature. eg: awaiting_signature, signed, declined."
1212
+
1213
+ "TeamAddMemberResponseExample::SUMMARY": Team Add Member
1214
+ "TeamCreateResponseExample::SUMMARY": Team Create
1215
+ "TeamGetResponseExample::SUMMARY": Team Get
1216
+ "TeamInfoResponseExample::SUMMARY": Team Get Info
1217
+ "TeamMembersResponseExample::SUMMARY": Team Members List
1218
+ "TeamSubTeamsResponseExample::SUMMARY": Team Sub Teams List
1219
+ "TeamRemoveMemberResponseExample::SUMMARY": Team Remove Member
1220
+ "TeamUpdateResponseExample::SUMMARY": Team Update
1221
+ "TeamDoesNotExistResponseExample::SUMMARY": Team Does Not Exist
1222
+ "Team::NAME": The name of your Team
1223
+ "Team::INVITED_ACCOUNTS": A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`.
1224
+ "TeamGeneral::TEAM_ID": The id of a team
1225
+ "TeamGeneral::NAME": The name of a team
1226
+ "TeamGeneral::NUM_MEMBERS": Number of members within a team
1227
+ "TeamGeneral::NUM_SUB_TEAMS": Number of sub teams within a team
1228
+ "TeamResponse::DESCRIPTION": Contains information about your team and its members
1229
+
1230
+ "TemplateAddUserResponseExample::SUMMARY": Add User to Template
1231
+ "TemplateCreateEmbeddedDraftResponseExample::SUMMARY": Create Embedded Draft Template
1232
+ "TemplateFilesResponseExample::SUMMARY": Template Files
1233
+ "TemplateGetResponseExample::SUMMARY": Get Template
1234
+ "TemplateListResponseExample::SUMMARY": List Templates
1235
+ "TemplateRemoveUserResponseExample::SUMMARY": Remove User from Template
1236
+ "TemplateUpdateFilesResponseExample::SUMMARY": Update Template Files
1237
+
1238
+ "TemplateResponse::DESCRIPTION": Contains information about the templates you and your team have created.
1239
+ "TemplateResponse::TEMPLATE_ID": The id of the Template.
1240
+ "TemplateResponse::CAN_EDIT": Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).
1241
+ "TemplateResponse::IS_CREATOR": "`true` if you are the owner of this template, `false` if it's been shared with you by a team member."
1242
+ "TemplateResponse::IS_EMBEDDED": "`true` if this template was created using an embedded flow, `false` if it was created on our website."
1243
+ "TemplateResponse::IS_LOCKED": |-
1244
+ Indicates whether the template is locked.
1245
+ If `true`, then the template was created outside your quota and can only be used in `test_mode`.
1246
+ If `false`, then the template is within your quota and can be used to create signature requests.
1247
+ "TemplateResponse::MESSAGE": The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.
1248
+ "TemplateResponse::METADATA": The metadata attached to the template.
1249
+ "TemplateResponse::SIGNER_ROLES": An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
1250
+ "TemplateResponse::CC_ROLES": An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
1251
+ "TemplateResponse::DOCUMENTS": An array describing each document associated with this Template. Includes form field data for each document.
1252
+ "TemplateResponse::CUSTOM_FIELDS": An array of Custom Field objects.
1253
+ "TemplateResponse::NAMED_FORM_FIELDS": Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
1254
+ "TemplateResponse::ACCOUNTS": An array of the Accounts that can use this Template.
1255
+ "TemplateResponse::TITLE": The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.
1256
+ "TemplateResponse::UPDATED_AT": Time the template was last updated.
1257
+
1258
+ "TemplateListResponse::DESCRIPTION": List of templates that the API caller has access to.
1259
+
1260
+ "TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION": "Template object with parameters: `template_id`, `edit_url`, `expires_at`."
1261
+ "TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL": Link to edit the template.
1262
+ "TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT": When the link expires.
1263
+
1264
+ "TemplateUpdateFilesResponseTemplate::DESCRIPTION": "Contains template id"
1265
+
1266
+ "TemplateResponseAccount::ACCOUNT_ID": The id of the Account.
1267
+ "TemplateResponseAccount::EMAIL_ADDRESS": The email address associated with the Account.
1268
+ "TemplateResponseAccount::IS_LOCKED": Returns `true` if the user has been locked out of their account by a team admin.
1269
+ "TemplateResponseAccount::IS_PAID_HS": Returns `true` if the user has a paid HelloSign account.
1270
+ "TemplateResponseAccount::IS_PAID_HF": Returns `true` if the user has a paid HelloFax account.
1271
+ "TemplateResponseAccount::QUOTAS": An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
1272
+
1273
+ "TemplateResponseAccountQuota::DESCRIPTION": An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
1274
+ "TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT": API signature requests remaining.
1275
+ "TemplateResponseAccountQuota::DOCUMENTS_LEFT": Signature requests remaining.
1276
+ "TemplateResponseAccountQuota::TEMPLATES_LEFT": API templates remaining.
1277
+ "TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining.
1278
+
1279
+ "TemplateResponseCCRole::TEMPLATES_LEFT": The name of the Role.
1280
+
1281
+ "TemplateResponseDocument::INDEX": Document ordering, the lowest index is displayed first and the highest last (0-based indexing).
1282
+ "TemplateResponseDocument::NAME": Name of the associated file.
1283
+ "TemplateResponseDocument::FIELD_GROUPS": An array of Form Field Group objects.
1284
+ "TemplateResponseDocument::STATIC_FIELDS": |-
1285
+ An array describing static overlay fields.
1286
+ <b>Note</b> only available for certain subscriptions.
1287
+ "TemplateResponseDocument::CUSTOM_FIELDS": An array of Document Custom Field objects.
1288
+ "TemplateResponseDocument::FORM_FIELDS": An array of Form Field objects containing the name and type of each named textbox and checkmark field.
1289
+
1290
+ "TemplateResponseDocumentCustomField::GROUP": The name of the group this field is in. If this field is not a group, this defaults to `null`.
1291
+ "TemplateResponseDocumentCustomField::HEIGHT": The height in pixels of this form field.
1292
+ "TemplateResponseDocumentCustomField::NAME": The name of the Custom Field.
1293
+ "TemplateResponseDocumentCustomField::REQUIRED": Boolean showing whether or not this field is required.
1294
+ "TemplateResponseDocumentCustomField::TYPE": The type of this Custom Field. Only `text` and `checkbox` are currently supported.
1295
+ "TemplateResponseDocumentCustomField::WIDTH": The width in pixels of this form field.
1296
+ "TemplateResponseDocumentCustomField::X": The horizontal offset in pixels for this form field.
1297
+ "TemplateResponseDocumentCustomField::Y": The vertical offset in pixels for this form field.
1298
+ "TemplateResponseDocumentCustomField::SIGNER": The signer of the Custom Field.
1299
+ "TemplateResponseDocumentCustomField::API_ID": The unique ID for this field.
1300
+ "TemplateResponseDocumentCustomField::IS_MULTILINE": Whether this form field is multiline text.
1301
+ "TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE": Original font size used in this form field's text.
1302
+ "TemplateResponseDocumentCustomField::FONT_FAMILY": Font family used in this form field's text.
1303
+ "TemplateResponseDocumentCustomField::NAMED_FORM_FIELDS": Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
1304
+
1305
+ "TemplateResponseCustomField::NAME": The name of the Custom Field.
1306
+ "TemplateResponseCustomField::TYPE": The type of this Custom Field. Only `text` and `checkbox` are currently supported.
1307
+ "TemplateResponseCustomField::X": The horizontal offset in pixels for this form field.
1308
+ "TemplateResponseCustomField::Y": The vertical offset in pixels for this form field.
1309
+ "TemplateResponseCustomField::WIDTH": The width in pixels of this form field.
1310
+ "TemplateResponseCustomField::HEIGHT": The height in pixels of this form field.
1311
+ "TemplateResponseCustomField::REQUIRED": Boolean showing whether or not this field is required.
1312
+ "TemplateResponseCustomField::API_ID": The unique ID for this field.
1313
+ "TemplateResponseCustomField::GROUP": The name of the group this field is in. If this field is not a group, this defaults to `null`.
1314
+ "TemplateResponseCustomField::IS_MULTILINE": Whether this form field is multiline text.
1315
+ "TemplateResponseCustomField::ORIGINAL_FONT_SIZE": Original font size used in this form field's text.
1316
+ "TemplateResponseCustomField::FONT_FAMILY": Font family used in this form field's text.
1317
+
1318
+ "TemplateResponseNamedFormField::NAME": The name of the Named Form Field.
1319
+ "TemplateResponseNamedFormField::TYPE": The type of this Named Form Field. Only `text` and `checkbox` are currently supported.
1320
+ "TemplateResponseNamedFormField::SIGNER": The signer of the Named Form Field.
1321
+ "TemplateResponseNamedFormField::X": The horizontal offset in pixels for this form field.
1322
+ "TemplateResponseNamedFormField::Y": The vertical offset in pixels for this form field.
1323
+ "TemplateResponseNamedFormField::WIDTH": The width in pixels of this form field.
1324
+ "TemplateResponseNamedFormField::HEIGHT": The height in pixels of this form field.
1325
+ "TemplateResponseNamedFormField::REQUIRED": Boolean showing whether or not this field is required.
1326
+ "TemplateResponseNamedFormField::API_ID": The unique ID for this field.
1327
+ "TemplateResponseNamedFormField::GROUP": The name of the group this field is in. If this field is not a group, this defaults to `null`.
1328
+ "TemplateResponseNamedFormField::IS_MULTILINE": Whether this form field is multiline text.
1329
+ "TemplateResponseNamedFormField::ORIGINAL_FONT_SIZE": Original font size used in this form field's text.
1330
+ "TemplateResponseNamedFormField::FONT_FAMILY": Font family used in this form field's text.
1331
+
1332
+ "TemplateResponseFieldAvgTextLength::DESCRIPTION": Average text length in this field.
1333
+ "TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE": Number of character per line.
1334
+ "TemplateResponseFieldAvgTextLength::NUM_LINES": Number of lines.
1335
+
1336
+ "TemplateResponseDocumentFieldGroup::NAME": The name of the form field group.
1337
+ "TemplateResponseDocumentFieldGroup::RULE": The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).
1338
+
1339
+ "TemplateResponseDocumentFormField::API_ID": A unique id for the form field.
1340
+ "TemplateResponseDocumentFormField::GROUP": The name of the group this field is in. If this field is not a group, this defaults to `null`.
1341
+ "TemplateResponseDocumentFormField::HEIGHT": The height in pixels of this form field.
1342
+ "TemplateResponseDocumentFormField::NAME": The name of the form field.
1343
+ "TemplateResponseDocumentFormField::REQUIRED": Boolean showing whether or not this field is required.
1344
+ "TemplateResponseDocumentFormField::TYPE": The type of this form field. See [field types](/api/reference/constants/#field-types).
1345
+ "TemplateResponseDocumentFormField::SIGNER": The signer of the Form Field.
1346
+ "TemplateResponseDocumentFormField::WIDTH": The width in pixels of this form field.
1347
+ "TemplateResponseDocumentFormField::X": The horizontal offset in pixels for this form field.
1348
+ "TemplateResponseDocumentFormField::Y": The vertical offset in pixels for this form field.
1349
+ "TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE": Original font size used in this form field's text.
1350
+ "TemplateResponseDocumentFormField::AVG_TEXT_LENGTH": Average text length in this field.
1351
+ "TemplateResponseDocumentFormField::IS_MULTILINE": Whether this form field is multiline text.
1352
+ "TemplateResponseDocumentFormField::FONT_FAMILY": Font family used in this form field's text.
1353
+
1354
+ "TemplateResponseDocumentFormField::DESCRIPTION": Average text length in this field.
1355
+ "TemplateResponseDocumentFormField::NUM_LINES": Number of lines.
1356
+ "TemplateResponseDocumentFormField::NUM_CHARS_PER_LINE": Number of character per line.
1357
+
1358
+ "TemplateResponseDocumentStaticField::NAME": The name of the static field.
1359
+ "TemplateResponseDocumentStaticField::TYPE": The type of this static field. See [field types](/api/reference/constants/#field-types).
1360
+ "TemplateResponseDocumentStaticField::SIGNER": The signer of the Static Field.
1361
+ "TemplateResponseDocumentStaticField::X": The horizontal offset in pixels for this static field.
1362
+ "TemplateResponseDocumentStaticField::Y": The vertical offset in pixels for this static field.
1363
+ "TemplateResponseDocumentStaticField::WIDTH": The width in pixels of this static field.
1364
+ "TemplateResponseDocumentStaticField::HEIGHT": The height in pixels of this static field.
1365
+ "TemplateResponseDocumentStaticField::REQUIRED": Boolean showing whether or not this field is required.
1366
+ "TemplateResponseDocumentStaticField::API_ID": A unique id for the static field.
1367
+ "TemplateResponseDocumentStaticField::GROUP": The name of the group this field is in. If this field is not a group, this defaults to `null`.
1368
+
1369
+ "TemplateResponseSignerRole::DESCRIPTION": An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
1370
+ "TemplateResponseSignerRole::NAME": The name of the Role.
1371
+ "TemplateResponseSignerRole::ORDER": If signer order is assigned this is the 0-based index for this role.
1372
+
1373
+ "FileResponse::FILE_URL": URL to the file.
1374
+ "FileResponse::EXPIRES_AT": When the link expires.
1375
+
1376
+ "UnclaimedDraftCreateResponseExample::SUMMARY": Unclaimed Draft Create
1377
+ "UnclaimedDraftCreateEmbeddedResponseExample::SUMMARY": Unclaimed Draft Create Embedded
1378
+ "UnclaimedDraftCreateEmbeddedWithTemplateResponseExample::SUMMARY": Unclaimed Draft Create Embedded With Template
1379
+ "UnclaimedDraftEditAndResendExample::SUMMARY": Unclaimed Draft Edit and Resend
1380
+ "UnclaimedDraft::CLAIM_URL": The URL to be used to claim this UnclaimedDraft.
1381
+ "UnclaimedDraft::EXPIRES_AT": When the link expires.
1382
+ "UnclaimedDraft::REQUESTING_REDIRECT_URL": The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).
1383
+ "UnclaimedDraft::SIGNATURE_REQUEST_ID": The ID of the signature request that is represented by this UnclaimedDraft.
1384
+ "UnclaimedDraft::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
1385
+ "UnclaimedDraft::TEST_MODE": Whether this is a test draft. Signature requests made from test drafts have no legal value.
1386
+
1387
+ "UnclaimedDraftResponse::DESCRIPTION": A group of documents that a user can take ownership of via the claim URL.
1388
+
1389
+ "ErrorResponseError::DESCRIPTION": Contains information about an error that occurred.
1390
+ "ErrorResponseError::ERROR_MSG": Message describing an error.
1391
+ "ErrorResponseError::ERROR_PATH": Path at which an error occurred.
1392
+ "ErrorResponseError::ERROR_NAME": Name of the error.
1393
+
1394
+ "Error::400": Error 400 bad_request
1395
+ "Error::401": Error 401 unauthorized
1396
+ "Error::402": Error 402 payment_required
1397
+ "Error::403": Error 403 forbidden
1398
+ "Error::404": Error 404 not_found
1399
+ "Error::409": Error 409 conflict
1400
+ "Error::410": Error 410 deleted
1401
+ "Error::422": Error 422 unprocessable_entity
1402
+ "Error::429": Error 429 exceeded_rate
1403
+ "Error::4XX": Error 4XX failed_operation
1404
+
1405
+ #########################
1406
+ # SEO for API Reference #
1407
+ #########################
1408
+ "AccountCreate::SEO::TITLE": "Create Account | API Documentation | HelloSign for Developers"
1409
+ "AccountCreate::SEO::DESCRIPTION": "The HelloSign API allows you to build with a range of tools. Find out how to create a new HelloSign Account using the specified `email_address` here."
1410
+ "AccountGet::SEO::TITLE": "Get Account | API Documentation | HelloSign for Developers"
1411
+ "AccountGet::SEO::DESCRIPTION": "The HelloSign API allows you to build with a wide range of tools. To find out how to return the properties and settings of your Account, click here."
1412
+ "AccountUpdate::SEO::TITLE": "Update Account | API Documentation | HelloSign for Developers"
1413
+ "AccountUpdate::SEO::DESCRIPTION": "The HelloSign API allows you to build with a wide range of tools. To find out how update the properties and settings of your Account, click here."
1414
+ "AccountVerify::SEO::TITLE": "Verify Account | API Documentation | HelloSign for Developers"
1415
+ "AccountVerify::SEO::DESCRIPTION": "The HelloSign API allows you to build with a wide range of tools. To find out how to verify whether an Account exists, click here."
1416
+ "ApiAppCreate::SEO::TITLE": "Create API App | API Documentation | HelloSign for Developers"
1417
+ "ApiAppCreate::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations with a wide range of tools. To find out how to create a new API App, click here."
1418
+ "ApiAppDelete::SEO::TITLE": "Delete API App | API Documentation | HelloSign for Developers"
1419
+ "ApiAppDelete::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations with a wide range of tools. To find out how to delete an API App, click here."
1420
+ "ApiAppGet::SEO::TITLE": "Get API App | API Documentation | HelloSign for Developers"
1421
+ "ApiAppGet::SEO::DESCRIPTION": "The HelloSign API allows you to build with a wide range of tools. To find out how to return an object with information about an API App, click here."
1422
+ "ApiAppList::SEO::TITLE": "List API Apps | API Documentation | HelloSign for Developers"
1423
+ "ApiAppList::SEO::DESCRIPTION": "The HelloSign API allows you to build with a wide range of tools. To find out how to return a list of API Apps that are accessible by you, click here."
1424
+ "ApiAppUpdate::SEO::TITLE": "Update API App | API Documentation | HelloSign for Developers"
1425
+ "ApiAppUpdate::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations with a wide range of tools. To find out how to update an App that you own, click here."
1426
+ "BulkSendJobGet::SEO::TITLE": "Get Bulk Send Job | API Documentation | HelloSign for Developers"
1427
+ "BulkSendJobGet::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations. To find out how to return the status of the BulkSendJob and SignatureRequests, click here."
1428
+ "BulkSendJobList::SEO::TITLE": "List Bulk Send Jobs | Documentation | HelloSign for Developers"
1429
+ "BulkSendJobList::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations. To find out how to return a list of BulkSendJob that you can access, click here."
1430
+ "EmbeddedEditUrl::SEO::TITLE": "Get Embedded Template URL | iFrame | HelloSign for Developers"
1431
+ "EmbeddedEditUrl::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a template url, click here."
1432
+ "EmbeddedSignUrl::SEO::TITLE": "Get Embedded Sign URL | iFrame | HelloSign for Developers"
1433
+ "EmbeddedSignUrl::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here."
1434
+ "OAuthTokenGenerate::SEO::TITLE": "Generate OAuth Token | Documentation | HelloSign for Developers"
1435
+ "OAuthTokenGenerate::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to generate a new OAuth token with the API, click here."
1436
+ "OAuthTokenRefresh::SEO::TITLE": "OAuth Token Refresh | Documentation | HelloSign for Developers"
1437
+ "OAuthTokenRefresh::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to refresh your OAuth token with the API, click here."
1438
+ "ReportCreate::SEO::TITLE": "Create Report | API Documentation | HelloSign for Developers"
1439
+ "ReportCreate::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to request the creation of one or more reports, click here."
1440
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::TITLE": "Embedded Bulk Send with Template | HelloSign for Developers"
1441
+ "SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::DESCRIPTION": "The RESTful HelloSign API allows you to build custom integrations. To find out how to create embedded BulkSendJob signature requests, click here."
1442
+ "SignatureRequestBulkSendWithTemplate::SEO::TITLE": "Bulk Send with Template | REST API | HelloSign for Developers"
1443
+ "SignatureRequestBulkSendWithTemplate::SEO::DESCRIPTION": "The RESTful HelloSign API allows you to build custom integrations. To find out how to create BulkSendJob for up to 250 signature requests, click here."
1444
+ "SignatureRequestCancel::SEO::TITLE": "Cancel Incomplete Signature Request | HelloSign for Developers"
1445
+ "SignatureRequestCancel::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to cancel an incomplete signature request, click here."
1446
+ "SignatureRequestCreateEmbedded::SEO::TITLE": "Create Embedded Signature Request | HelloSign for Developers"
1447
+ "SignatureRequestCreateEmbedded::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom integrations. To find out how to create a new SignatureRequest in an iFrame, click here."
1448
+ "SignatureRequestCreateEmbeddedWithTemplate::SEO::TITLE": "Signature Request with Template | HelloSign for Developers"
1449
+ "SignatureRequestCreateEmbeddedWithTemplate::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here."
1450
+ "SignatureRequestFiles::SEO::TITLE": "Download Files | API Documentation | HelloSign for Developers"
1451
+ "SignatureRequestFiles::SEO::DESCRIPTION": "The RESTful HelloSign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here"
1452
+ "SignatureRequestGet::SEO::TITLE": "Get Signature Request | Documentation | HelloSign for Developers"
1453
+ "SignatureRequestGet::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here."
1454
+ "SignatureRequestList::SEO::TITLE": "List Signature Requests | REST API | HelloSign for Developers"
1455
+ "SignatureRequestList::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here."
1456
+ "SignatureRequestReleaseHold::SEO::TITLE": "Release On-Hold Signature Request | HelloSign for Developers"
1457
+ "SignatureRequestReleaseHold::SEO::DESCRIPTION": "The RESTful HelloSign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here."
1458
+ "SignatureRequestRemind::SEO::TITLE": "Send Request Reminder | REST API | HelloSign for Developers"
1459
+ "SignatureRequestRemind::SEO::DESCRIPTION": "The RESTful HelloSign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here."
1460
+ "SignatureRequestRemove::SEO::TITLE": "Remove Signature Request Access | HelloSign for Developers"
1461
+ "SignatureRequestRemove::SEO::DESCRIPTION": "The RESTful HelloSign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here."
1462
+ "SignatureRequestSend::SEO::TITLE": "Send Signature Request | REST API | HelloSign for Developers"
1463
+ "SignatureRequestSend::SEO::DESCRIPTION": "HelloSign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here."
1464
+ "SignatureRequestSendWithTemplate::SEO::TITLE": "Send with Template | API Documentation | HelloSign for Developers"
1465
+ "SignatureRequestSendWithTemplate::SEO::DESCRIPTION": "HelloSign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here."
1466
+ "SignatureRequestUpdate::SEO::TITLE": "Update Signature Request | REST API | HelloSign for Developers"
1467
+ "SignatureRequestUpdate::SEO::DESCRIPTION": "HelloSign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here."
1468
+ "TeamAddMember::SEO::TITLE": "Add User to Team | API Documentation | HelloSign for Developers"
1469
+ "TeamAddMember::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here."
1470
+ "TeamCreate::SEO::TITLE": "Create Team | REST API Documentation | HelloSign for Developers"
1471
+ "TeamCreate::SEO::DESCRIPTION": "The RESTful HelloSign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here."
1472
+ "TeamDelete::SEO::TITLE": "Delete Team | REST API Documentation | HelloSign for Developers"
1473
+ "TeamDelete::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here."
1474
+ "TeamGet::SEO::TITLE": "Get Team | REST API Documentation | HelloSign for Developers"
1475
+ "TeamGet::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here."
1476
+ "TeamInfo::SEO::TITLE": "Get Team Info | HelloSign for Developers"
1477
+ "TeamInfo::SEO::DESCRIPTION": "The HelloSign API allows you automate your team management. To find out how to get information about a specific team, click here."
1478
+ "TeamMembers::SEO::TITLE": "List Team Members | HelloSign for Developers"
1479
+ "TeamMembers::SEO::DESCRIPTION": "The HelloSign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here."
1480
+ "TeamRemoveMember::SEO::TITLE": "Remove User from Team | REST API | HelloSign for Developers"
1481
+ "TeamRemoveMember::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here."
1482
+ "TeamSubTeams::SEO::TITLE": "List Sub Teams | HelloSign for Developers"
1483
+ "TeamSubTeams::SEO::DESCRIPTION": "The HelloSign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here."
1484
+ "TeamUpdate::SEO::TITLE": "Update Team | API Documentation | HelloSign for Developers"
1485
+ "TeamUpdate::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here."
1486
+ "TemplateAddUser::SEO::TITLE": "Add User to Template | REST API | HelloSign for Developers"
1487
+ "TemplateAddUser::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here."
1488
+ "TemplateCreateEmbeddedDraft::SEO::TITLE": "Create Embedded Template Draft | HelloSign for Developers"
1489
+ "TemplateCreateEmbeddedDraft::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here."
1490
+ "TemplateDelete::SEO::TITLE": "Delete Template | API Documentation | HelloSign for Developers"
1491
+ "TemplateDelete::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here."
1492
+ "TemplateFiles::SEO::TITLE": "Get Template Files | API Documentation | HelloSign for Developers"
1493
+ "TemplateFiles::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here."
1494
+ "TemplateGet::SEO::TITLE": "Get Template | API Documentation | HelloSign for Developers"
1495
+ "TemplateGet::SEO::DESCRIPTION": "The RESTful HelloSign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here."
1496
+ "TemplateList::SEO::TITLE": "List Templates | API Documentation | HelloSign for Developers"
1497
+ "TemplateList::SEO::DESCRIPTION": "The HelloSign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here."
1498
+ "TemplateRemoveUser::SEO::TITLE": "Remove User from Template | REST API | HelloSign for Developers"
1499
+ "TemplateRemoveUser::SEO::DESCRIPTION": "The HelloSign API easily allows you to build custom integrations. To find out how to remove a specified Account's access to a Template, click here."
1500
+ "TemplateUpdateFiles::SEO::TITLE": "Update Template Files | REST API | HelloSign for Developers"
1501
+ "TemplateUpdateFiles::SEO::DESCRIPTION": "Overlays a new file with the overlay of an existing template"
1502
+ "UnclaimedDraftCreate::SEO::TITLE": "Create Unclaimed Draft | REST API | HelloSign for Developers"
1503
+ "UnclaimedDraftCreate::SEO::DESCRIPTION": "The HelloSign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here."
1504
+ "UnclaimedDraftCreateEmbedded::SEO::TITLE": "Create Embedded Unclaimed Draft | HelloSign for Developers"
1505
+ "UnclaimedDraftCreateEmbedded::SEO::DESCRIPTION": "The HelloSign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here."
1506
+ "UnclaimedDraftCreateEmbeddedWithTemplate::SEO::TITLE": "Embed Unclaimed Draft with Template | HelloSign for Developers"
1507
+ "UnclaimedDraftCreateEmbeddedWithTemplate::SEO::DESCRIPTION": "The HelloSign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here."
1508
+ "UnclaimedDraftEditAndResend::SEO::TITLE": "Edit and Resend Unclaimed Draft | HelloSign for Developers"
1509
+ "UnclaimedDraftEditAndResend::SEO::DESCRIPTION": "The HelloSign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here."
1510
+ "accountUpdateEventCallback::SEO::TITLE": "Account Callbacks | API Documentation | HelloSign for Developers"
1511
+ "accountUpdateEventCallback::SEO::DESCRIPTION": "The HelloSign API allows you to build with a wide range of tools. To find out how to consume HelloSign Events at the account level, click here."
1512
+ "apiAppCreateEventCallback::SEO::TITLE": "App Callbacks | API Documentation | HelloSign for Developers"
1513
+ "apiAppCreateEventCallback::SEO::DESCRIPTION": "The HelloSign API allows you to build with a wide range of tools. To find out how to consume HelloSign Events at the App level, click here."