dropbox-sign 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (412) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -5
  3. data/README.md +23 -16
  4. data/VERSION +1 -1
  5. data/docs/AccountApi.md +33 -38
  6. data/docs/ApiAppApi.md +64 -64
  7. data/docs/BulkSendJobApi.md +21 -21
  8. data/docs/EmbeddedApi.md +22 -22
  9. data/docs/FaxApi.md +57 -55
  10. data/docs/FaxLineAddUserRequest.md +1 -1
  11. data/docs/FaxLineApi.md +74 -63
  12. data/docs/FaxLineCreateRequest.md +4 -4
  13. data/docs/FaxLineDeleteRequest.md +1 -1
  14. data/docs/FaxLineRemoveUserRequest.md +3 -3
  15. data/docs/FaxSendRequest.md +5 -5
  16. data/docs/OAuthApi.md +27 -15
  17. data/docs/ReportApi.md +14 -13
  18. data/docs/SignatureRequestApi.md +822 -311
  19. data/docs/SignatureRequestEditEmbeddedRequest.md +33 -0
  20. data/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +24 -0
  21. data/docs/SignatureRequestEditRequest.md +34 -0
  22. data/docs/SignatureRequestEditWithTemplateRequest.md +25 -0
  23. data/docs/TeamApi.md +84 -95
  24. data/docs/TemplateApi.md +210 -166
  25. data/docs/UnclaimedDraftApi.md +77 -91
  26. data/dropbox-sign.gemspec +1 -1
  27. data/examples/AccountCreateExample.rb +20 -0
  28. data/examples/AccountCreateOauthExample.rb +22 -0
  29. data/examples/AccountGetExample.rb +15 -0
  30. data/examples/AccountUpdateExample.rb +21 -0
  31. data/examples/AccountVerifyExample.rb +20 -0
  32. data/examples/ApiAppCreateExample.rb +37 -0
  33. data/examples/ApiAppDeleteExample.rb +15 -0
  34. data/examples/ApiAppGetExample.rb +17 -0
  35. data/examples/ApiAppListExample.rb +20 -0
  36. data/examples/ApiAppUpdateExample.rb +39 -0
  37. data/examples/BulkSendJobGetExample.rb +21 -0
  38. data/examples/BulkSendJobListExample.rb +20 -0
  39. data/examples/EmbeddedEditUrlExample.rb +27 -0
  40. data/examples/EmbeddedSignUrlExample.rb +17 -0
  41. data/examples/FaxDeleteExample.rb +14 -0
  42. data/examples/FaxFilesExample.rb +16 -0
  43. data/examples/FaxGetExample.rb +16 -0
  44. data/examples/FaxLineAddUserExample.rb +20 -0
  45. data/examples/FaxLineAreaCodeGetExample.rb +16 -0
  46. data/examples/FaxLineCreateExample.rb +20 -0
  47. data/examples/FaxLineDeleteExample.rb +17 -0
  48. data/examples/FaxLineGetExample.rb +16 -0
  49. data/examples/FaxLineListExample.rb +21 -0
  50. data/examples/FaxLineRemoveUserExample.rb +20 -0
  51. data/examples/FaxListExample.rb +19 -0
  52. data/examples/FaxSendExample.rb +28 -0
  53. data/examples/OauthTokenGenerateExample.rb +22 -0
  54. data/examples/OauthTokenRefreshExample.rb +19 -0
  55. data/examples/ReportCreateExample.rb +24 -0
  56. data/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb +84 -0
  57. data/examples/SignatureRequestBulkSendWithTemplateExample.rb +84 -0
  58. data/examples/SignatureRequestCancelExample.rb +15 -0
  59. data/examples/SignatureRequestCreateEmbeddedExample.rb +55 -0
  60. data/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb +81 -0
  61. data/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb +44 -0
  62. data/examples/SignatureRequestEditEmbeddedExample.rb +56 -0
  63. data/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb +82 -0
  64. data/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb +45 -0
  65. data/examples/SignatureRequestEditExample.rb +66 -0
  66. data/examples/SignatureRequestEditGroupedSignersExample.rb +92 -0
  67. data/examples/SignatureRequestEditWithTemplateExample.rb +64 -0
  68. data/examples/SignatureRequestFilesAsDataUriExample.rb +17 -0
  69. data/examples/SignatureRequestFilesAsFileUrlExample.rb +20 -0
  70. data/examples/SignatureRequestFilesExample.rb +20 -0
  71. data/examples/SignatureRequestGetExample.rb +17 -0
  72. data/examples/SignatureRequestListExample.rb +22 -0
  73. data/examples/SignatureRequestReleaseHoldExample.rb +17 -0
  74. data/examples/SignatureRequestRemindExample.rb +21 -0
  75. data/examples/SignatureRequestRemoveExample.rb +14 -0
  76. data/examples/SignatureRequestSendExample.rb +65 -0
  77. data/examples/SignatureRequestSendGroupedSignersExample.rb +91 -0
  78. data/examples/SignatureRequestSendWithTemplateExample.rb +63 -0
  79. data/examples/SignatureRequestUpdateExample.rb +22 -0
  80. data/examples/TeamAddMemberAccountIdExample.rb +23 -0
  81. data/examples/TeamAddMemberExample.rb +23 -0
  82. data/examples/TeamCreateExample.rb +20 -0
  83. data/examples/TeamDeleteExample.rb +13 -0
  84. data/examples/TeamGetExample.rb +15 -0
  85. data/examples/TeamInfoExample.rb +19 -0
  86. data/examples/TeamInvitesExample.rb +15 -0
  87. data/examples/TeamMembersExample.rb +21 -0
  88. data/examples/TeamRemoveMemberAccountIdExample.rb +20 -0
  89. data/examples/TeamRemoveMemberExample.rb +21 -0
  90. data/examples/TeamSubTeamsExample.rb +21 -0
  91. data/examples/TeamUpdateExample.rb +20 -0
  92. data/examples/TemplateAddUserExample.rb +21 -0
  93. data/examples/TemplateCreateEmbeddedDraftExample.rb +62 -0
  94. data/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb +108 -0
  95. data/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb +124 -0
  96. data/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb +96 -0
  97. data/examples/TemplateCreateExample.rb +96 -0
  98. data/examples/TemplateCreateFormFieldGroupsExample.rb +108 -0
  99. data/examples/TemplateCreateFormFieldRulesExample.rb +124 -0
  100. data/examples/TemplateCreateFormFieldsPerDocumentExample.rb +96 -0
  101. data/examples/TemplateDeleteExample.rb +15 -0
  102. data/examples/TemplateFilesAsDataUriExample.rb +17 -0
  103. data/examples/TemplateFilesAsFileUrlExample.rb +20 -0
  104. data/examples/TemplateFilesExample.rb +17 -0
  105. data/examples/TemplateGetExample.rb +17 -0
  106. data/examples/TemplateListExample.rb +22 -0
  107. data/examples/TemplateRemoveUserExample.rb +21 -0
  108. data/examples/TemplateUpdateFilesExample.rb +23 -0
  109. data/examples/UnclaimedDraftCreateEmbeddedExample.rb +25 -0
  110. data/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb +71 -0
  111. data/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb +87 -0
  112. data/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb +59 -0
  113. data/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb +44 -0
  114. data/examples/UnclaimedDraftCreateExample.rb +34 -0
  115. data/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb +70 -0
  116. data/examples/UnclaimedDraftCreateFormFieldRulesExample.rb +86 -0
  117. data/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb +58 -0
  118. data/examples/UnclaimedDraftEditAndResendExample.rb +22 -0
  119. data/lib/dropbox-sign/api/account_api.rb +1 -1
  120. data/lib/dropbox-sign/api/api_app_api.rb +1 -1
  121. data/lib/dropbox-sign/api/bulk_send_job_api.rb +1 -1
  122. data/lib/dropbox-sign/api/embedded_api.rb +1 -1
  123. data/lib/dropbox-sign/api/fax_api.rb +17 -17
  124. data/lib/dropbox-sign/api/fax_line_api.rb +23 -23
  125. data/lib/dropbox-sign/api/o_auth_api.rb +1 -1
  126. data/lib/dropbox-sign/api/report_api.rb +1 -1
  127. data/lib/dropbox-sign/api/signature_request_api.rb +461 -1
  128. data/lib/dropbox-sign/api/team_api.rb +1 -1
  129. data/lib/dropbox-sign/api/template_api.rb +1 -1
  130. data/lib/dropbox-sign/api/unclaimed_draft_api.rb +1 -1
  131. data/lib/dropbox-sign/api_client.rb +8 -9
  132. data/lib/dropbox-sign/api_error.rb +1 -1
  133. data/lib/dropbox-sign/configuration.rb +1 -1
  134. data/lib/dropbox-sign/event_callback_helper.rb +1 -1
  135. data/lib/dropbox-sign/models/account_create_request.rb +19 -3
  136. data/lib/dropbox-sign/models/account_create_response.rb +19 -3
  137. data/lib/dropbox-sign/models/account_get_response.rb +19 -3
  138. data/lib/dropbox-sign/models/account_response.rb +9 -3
  139. data/lib/dropbox-sign/models/account_response_quotas.rb +9 -3
  140. data/lib/dropbox-sign/models/account_response_usage.rb +9 -3
  141. data/lib/dropbox-sign/models/account_update_request.rb +9 -3
  142. data/lib/dropbox-sign/models/account_verify_request.rb +19 -3
  143. data/lib/dropbox-sign/models/account_verify_response.rb +9 -3
  144. data/lib/dropbox-sign/models/account_verify_response_account.rb +9 -3
  145. data/lib/dropbox-sign/models/api_app_create_request.rb +19 -3
  146. data/lib/dropbox-sign/models/api_app_get_response.rb +19 -3
  147. data/lib/dropbox-sign/models/api_app_list_response.rb +29 -3
  148. data/lib/dropbox-sign/models/api_app_response.rb +9 -3
  149. data/lib/dropbox-sign/models/api_app_response_o_auth.rb +9 -3
  150. data/lib/dropbox-sign/models/api_app_response_options.rb +9 -3
  151. data/lib/dropbox-sign/models/api_app_response_owner_account.rb +9 -3
  152. data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +9 -3
  153. data/lib/dropbox-sign/models/api_app_update_request.rb +9 -3
  154. data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +39 -3
  155. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +9 -3
  156. data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +29 -3
  157. data/lib/dropbox-sign/models/bulk_send_job_response.rb +9 -3
  158. data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +19 -3
  159. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +9 -3
  160. data/lib/dropbox-sign/models/embedded_edit_url_response.rb +19 -3
  161. data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +9 -3
  162. data/lib/dropbox-sign/models/embedded_sign_url_response.rb +19 -3
  163. data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +9 -3
  164. data/lib/dropbox-sign/models/error_response.rb +19 -3
  165. data/lib/dropbox-sign/models/error_response_error.rb +29 -3
  166. data/lib/dropbox-sign/models/event_callback_request.rb +19 -3
  167. data/lib/dropbox-sign/models/event_callback_request_event.rb +29 -3
  168. data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +9 -3
  169. data/lib/dropbox-sign/models/fax_get_response.rb +19 -3
  170. data/lib/dropbox-sign/models/fax_line_add_user_request.rb +20 -4
  171. data/lib/dropbox-sign/models/fax_line_area_code_get_country_enum.rb +1 -1
  172. data/lib/dropbox-sign/models/fax_line_area_code_get_province_enum.rb +1 -1
  173. data/lib/dropbox-sign/models/fax_line_area_code_get_response.rb +19 -3
  174. data/lib/dropbox-sign/models/fax_line_area_code_get_state_enum.rb +1 -1
  175. data/lib/dropbox-sign/models/fax_line_create_request.rb +23 -7
  176. data/lib/dropbox-sign/models/fax_line_delete_request.rb +20 -4
  177. data/lib/dropbox-sign/models/fax_line_list_response.rb +29 -3
  178. data/lib/dropbox-sign/models/fax_line_remove_user_request.rb +22 -6
  179. data/lib/dropbox-sign/models/fax_line_response.rb +19 -3
  180. data/lib/dropbox-sign/models/fax_line_response_fax_line.rb +9 -3
  181. data/lib/dropbox-sign/models/fax_list_response.rb +29 -3
  182. data/lib/dropbox-sign/models/fax_response.rb +89 -3
  183. data/lib/dropbox-sign/models/fax_response_transmission.rb +19 -3
  184. data/lib/dropbox-sign/models/fax_send_request.rb +24 -8
  185. data/lib/dropbox-sign/models/file_response.rb +29 -3
  186. data/lib/dropbox-sign/models/file_response_data_uri.rb +19 -3
  187. data/lib/dropbox-sign/models/list_info_response.rb +9 -3
  188. data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +59 -3
  189. data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +29 -3
  190. data/lib/dropbox-sign/models/o_auth_token_response.rb +9 -3
  191. data/lib/dropbox-sign/models/report_create_request.rb +29 -3
  192. data/lib/dropbox-sign/models/report_create_response.rb +19 -3
  193. data/lib/dropbox-sign/models/report_response.rb +9 -3
  194. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +29 -3
  195. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +19 -3
  196. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +19 -3
  197. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +39 -3
  198. data/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +604 -0
  199. data/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +521 -0
  200. data/lib/dropbox-sign/models/signature_request_edit_request.rb +600 -0
  201. data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +518 -0
  202. data/lib/dropbox-sign/models/signature_request_get_response.rb +19 -3
  203. data/lib/dropbox-sign/models/signature_request_list_response.rb +29 -3
  204. data/lib/dropbox-sign/models/signature_request_remind_request.rb +19 -3
  205. data/lib/dropbox-sign/models/signature_request_response.rb +9 -3
  206. data/lib/dropbox-sign/models/signature_request_response_attachment.rb +49 -3
  207. data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +29 -3
  208. data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +19 -3
  209. data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +19 -3
  210. data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +1 -1
  211. data/lib/dropbox-sign/models/signature_request_response_data_base.rb +9 -3
  212. data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +1 -1
  213. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +9 -3
  214. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +9 -3
  215. data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +9 -3
  216. data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +9 -3
  217. data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +9 -3
  218. data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +9 -3
  219. data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +9 -3
  220. data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +9 -3
  221. data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +9 -3
  222. data/lib/dropbox-sign/models/signature_request_response_signatures.rb +9 -3
  223. data/lib/dropbox-sign/models/signature_request_send_request.rb +9 -3
  224. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +29 -3
  225. data/lib/dropbox-sign/models/signature_request_update_request.rb +19 -3
  226. data/lib/dropbox-sign/models/sub_attachment.rb +29 -3
  227. data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +9 -3
  228. data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +29 -3
  229. data/lib/dropbox-sign/models/sub_cc.rb +29 -3
  230. data/lib/dropbox-sign/models/sub_custom_field.rb +19 -3
  231. data/lib/dropbox-sign/models/sub_editor_options.rb +9 -3
  232. data/lib/dropbox-sign/models/sub_field_options.rb +9 -3
  233. data/lib/dropbox-sign/models/sub_form_field_group.rb +39 -3
  234. data/lib/dropbox-sign/models/sub_form_field_rule.rb +29 -3
  235. data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +19 -3
  236. data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +19 -3
  237. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +99 -3
  238. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +29 -3
  239. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +19 -3
  240. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +19 -3
  241. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +19 -3
  242. data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +1 -1
  243. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +39 -3
  244. data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +19 -3
  245. data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +39 -3
  246. data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +19 -3
  247. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +19 -3
  248. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +19 -3
  249. data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +1 -1
  250. data/lib/dropbox-sign/models/sub_merge_field.rb +19 -3
  251. data/lib/dropbox-sign/models/sub_o_auth.rb +9 -3
  252. data/lib/dropbox-sign/models/sub_options.rb +9 -3
  253. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +29 -3
  254. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +29 -3
  255. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +39 -3
  256. data/lib/dropbox-sign/models/sub_signing_options.rb +9 -3
  257. data/lib/dropbox-sign/models/sub_team_response.rb +9 -3
  258. data/lib/dropbox-sign/models/sub_template_role.rb +9 -3
  259. data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +29 -3
  260. data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +39 -3
  261. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +9 -3
  262. data/lib/dropbox-sign/models/team_add_member_request.rb +9 -3
  263. data/lib/dropbox-sign/models/team_create_request.rb +9 -3
  264. data/lib/dropbox-sign/models/team_get_info_response.rb +19 -3
  265. data/lib/dropbox-sign/models/team_get_response.rb +19 -3
  266. data/lib/dropbox-sign/models/team_info_response.rb +9 -3
  267. data/lib/dropbox-sign/models/team_invite_response.rb +9 -3
  268. data/lib/dropbox-sign/models/team_invites_response.rb +19 -3
  269. data/lib/dropbox-sign/models/team_member_response.rb +9 -3
  270. data/lib/dropbox-sign/models/team_members_response.rb +29 -3
  271. data/lib/dropbox-sign/models/team_parent_response.rb +9 -3
  272. data/lib/dropbox-sign/models/team_remove_member_request.rb +9 -3
  273. data/lib/dropbox-sign/models/team_response.rb +9 -3
  274. data/lib/dropbox-sign/models/team_sub_teams_response.rb +29 -3
  275. data/lib/dropbox-sign/models/team_update_request.rb +9 -3
  276. data/lib/dropbox-sign/models/template_add_user_request.rb +9 -3
  277. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +19 -3
  278. data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +19 -3
  279. data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +9 -3
  280. data/lib/dropbox-sign/models/template_create_request.rb +29 -3
  281. data/lib/dropbox-sign/models/template_create_response.rb +19 -3
  282. data/lib/dropbox-sign/models/template_create_response_template.rb +9 -3
  283. data/lib/dropbox-sign/models/template_edit_response.rb +19 -3
  284. data/lib/dropbox-sign/models/template_get_response.rb +19 -3
  285. data/lib/dropbox-sign/models/template_list_response.rb +29 -3
  286. data/lib/dropbox-sign/models/template_remove_user_request.rb +9 -3
  287. data/lib/dropbox-sign/models/template_response.rb +9 -3
  288. data/lib/dropbox-sign/models/template_response_account.rb +9 -3
  289. data/lib/dropbox-sign/models/template_response_account_quota.rb +9 -3
  290. data/lib/dropbox-sign/models/template_response_cc_role.rb +9 -3
  291. data/lib/dropbox-sign/models/template_response_document.rb +9 -3
  292. data/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +19 -3
  293. data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +19 -3
  294. data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +19 -3
  295. data/lib/dropbox-sign/models/template_response_document_field_group.rb +9 -3
  296. data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +9 -3
  297. data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +19 -3
  298. data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +19 -3
  299. data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +19 -3
  300. data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +19 -3
  301. data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +19 -3
  302. data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +19 -3
  303. data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +29 -3
  304. data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +19 -3
  305. data/lib/dropbox-sign/models/template_response_document_form_field_text.rb +19 -3
  306. data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +19 -3
  307. data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +19 -3
  308. data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +19 -3
  309. data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +19 -3
  310. data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +19 -3
  311. data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +19 -3
  312. data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +19 -3
  313. data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +19 -3
  314. data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +19 -3
  315. data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +9 -3
  316. data/lib/dropbox-sign/models/template_response_signer_role.rb +9 -3
  317. data/lib/dropbox-sign/models/template_update_files_request.rb +9 -3
  318. data/lib/dropbox-sign/models/template_update_files_response.rb +19 -3
  319. data/lib/dropbox-sign/models/template_update_files_response_template.rb +9 -3
  320. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +29 -3
  321. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +39 -3
  322. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +9 -3
  323. data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +19 -3
  324. data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +19 -3
  325. data/lib/dropbox-sign/models/unclaimed_draft_response.rb +9 -3
  326. data/lib/dropbox-sign/models/warning_response.rb +29 -3
  327. data/lib/dropbox-sign/version.rb +2 -2
  328. data/lib/dropbox-sign.rb +5 -1
  329. data/openapi-config.yaml +4 -1
  330. data/openapi-sdk.yaml +3332 -2700
  331. data/run-build +1 -1
  332. data/spec/spec_helper.rb +1 -1
  333. data/templates/README.mustache +2 -2
  334. data/templates/api_client_typhoeus_partial.mustache +7 -8
  335. data/templates/api_doc.mustache +2 -2
  336. data/templates/configuration.mustache +1 -1
  337. data/templates/partial_model_generic.mustache +28 -6
  338. metadata +109 -82
  339. data/examples/AccountCreate.rb +0 -21
  340. data/examples/AccountGet.rb +0 -18
  341. data/examples/AccountUpdate.rb +0 -21
  342. data/examples/AccountVerify.rb +0 -21
  343. data/examples/ApiAppCreate.rb +0 -35
  344. data/examples/ApiAppDelete.rb +0 -20
  345. data/examples/ApiAppGet.rb +0 -20
  346. data/examples/ApiAppList.rb +0 -21
  347. data/examples/ApiAppUpdate.rb +0 -32
  348. data/examples/BulkSendJobGet.rb +0 -20
  349. data/examples/BulkSendJobList.rb +0 -21
  350. data/examples/EmbeddedEditUrl.rb +0 -24
  351. data/examples/EmbeddedSignUrl.rb +0 -20
  352. data/examples/FaxDelete.rb +0 -14
  353. data/examples/FaxFiles.rb +0 -17
  354. data/examples/FaxGet.rb +0 -17
  355. data/examples/FaxLineAddUser.rb +0 -19
  356. data/examples/FaxLineAreaCodeGet.rb +0 -15
  357. data/examples/FaxLineCreate.rb +0 -19
  358. data/examples/FaxLineDelete.rb +0 -17
  359. data/examples/FaxLineGet.rb +0 -15
  360. data/examples/FaxLineList.rb +0 -15
  361. data/examples/FaxLineRemoveUser.rb +0 -19
  362. data/examples/FaxList.rb +0 -18
  363. data/examples/FaxSend.rb +0 -25
  364. data/examples/OauthTokenGenerate.rb +0 -16
  365. data/examples/OauthTokenRefresh.rb +0 -13
  366. data/examples/ReportCreate.rb +0 -23
  367. data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +0 -59
  368. data/examples/SignatureRequestBulkSendWithTemplate.rb +0 -58
  369. data/examples/SignatureRequestCancel.rb +0 -20
  370. data/examples/SignatureRequestCreateEmbedded.rb +0 -46
  371. data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +0 -39
  372. data/examples/SignatureRequestEdit.rb +0 -58
  373. data/examples/SignatureRequestEditEmbedded.rb +0 -48
  374. data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +0 -41
  375. data/examples/SignatureRequestEditWithTemplate.rb +0 -52
  376. data/examples/SignatureRequestFiles.rb +0 -20
  377. data/examples/SignatureRequestFilesAsDataUri.rb +0 -20
  378. data/examples/SignatureRequestFilesAsFileUrl.rb +0 -20
  379. data/examples/SignatureRequestGet.rb +0 -20
  380. data/examples/SignatureRequestList.rb +0 -21
  381. data/examples/SignatureRequestReleaseHold.rb +0 -20
  382. data/examples/SignatureRequestRemind.rb +0 -23
  383. data/examples/SignatureRequestRemove.rb +0 -20
  384. data/examples/SignatureRequestSend.rb +0 -56
  385. data/examples/SignatureRequestSendWithTemplate.rb +0 -50
  386. data/examples/SignatureRequestUpdate.rb +0 -24
  387. data/examples/TeamAddMember.rb +0 -21
  388. data/examples/TeamCreate.rb +0 -21
  389. data/examples/TeamDelete.rb +0 -18
  390. data/examples/TeamGet.rb +0 -18
  391. data/examples/TeamInfo.rb +0 -18
  392. data/examples/TeamInvites.rb +0 -20
  393. data/examples/TeamMembers.rb +0 -20
  394. data/examples/TeamRemoveMember.rb +0 -22
  395. data/examples/TeamSubTeams.rb +0 -20
  396. data/examples/TeamUpdate.rb +0 -21
  397. data/examples/TemplateAddUser.rb +0 -23
  398. data/examples/TemplateCreate.rb +0 -49
  399. data/examples/TemplateCreateEmbeddedDraft.rb +0 -49
  400. data/examples/TemplateDelete.rb +0 -20
  401. data/examples/TemplateFiles.rb +0 -20
  402. data/examples/TemplateFilesAsDataUri.rb +0 -20
  403. data/examples/TemplateFilesAsFileUrl.rb +0 -20
  404. data/examples/TemplateGet.rb +0 -20
  405. data/examples/TemplateList.rb +0 -20
  406. data/examples/TemplateRemoveUser.rb +0 -23
  407. data/examples/TemplateUpdateFiles.rb +0 -23
  408. data/examples/UnclaimedDraftCreate.rb +0 -56
  409. data/examples/UnclaimedDraftCreateEmbedded.rb +0 -24
  410. data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +0 -35
  411. data/examples/UnclaimedDraftEditAndResend.rb +0 -24
  412. /data/examples/{EventCallback.rb → EventCallbackExample.rb} +0 -0
@@ -0,0 +1,33 @@
1
+ # Dropbox::Sign::SignatureRequestEditEmbeddedRequest
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `client_id`<sup>*_required_</sup> | ```String``` | Client id of the app you&#39;re using to create this embedded signature request. Used for security purposes. | |
10
+ | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
11
+ | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
12
+ | `signers` | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
13
+ | `grouped_signers` | [```Array<SubSignatureRequestGroupedSigners>```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
14
+ | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
15
+ | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**NOTE:** Only available for Premium plan. | [default to false] |
16
+ | `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
17
+ | `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
18
+ | `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.<br><br>Pre-filled data can be used with &quot;send-once&quot; 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.<br><br>For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | |
19
+ | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
20
+ | `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | 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`. | |
21
+ | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
22
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**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.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
23
+ | `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**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. | [default to false] |
24
+ | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
25
+ | `metadata` | ```Hash<String, Object>``` | 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&#39;s order number for look up when receiving events for the signature request.<br><br>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. | |
26
+ | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
27
+ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
28
+ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
29
+ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
30
+ | `use_text_tags` | ```Boolean``` | 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`. | [default to false] |
31
+ | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer&#39;s information during signing.<br><br>**NOTE:** Keep your signer&#39;s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
32
+ | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |
33
+
@@ -0,0 +1,24 @@
1
+ # Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `template_ids`<sup>*_required_</sup> | ```Array<String>``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | |
10
+ | `client_id`<sup>*_required_</sup> | ```String``` | Client id of the app you&#39;re using to create this embedded signature request. Used for security purposes. | |
11
+ | `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestTemplateSigner>```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | |
12
+ | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
13
+ | `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
14
+ | `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
15
+ | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
16
+ | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
17
+ | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
18
+ | `metadata` | ```Hash<String, Object>``` | 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&#39;s order number for look up when receiving events for the signature request.<br><br>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. | |
19
+ | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
20
+ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
21
+ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
22
+ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
23
+ | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer&#39;s information during signing.<br><br>**NOTE:** Keep your signer&#39;s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
24
+
@@ -0,0 +1,34 @@
1
+ # Dropbox::Sign::SignatureRequestEditRequest
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
10
+ | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
11
+ | `signers` | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
12
+ | `grouped_signers` | [```Array<SubSignatureRequestGroupedSigners>```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
13
+ | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
14
+ | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**NOTE:** Only available for Premium plan and higher. | [default to false] |
15
+ | `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
16
+ | `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
17
+ | `client_id` | ```String``` | 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. | |
18
+ | `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.<br><br>Pre-filled data can be used with &quot;send-once&quot; 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.<br><br>For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | |
19
+ | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
20
+ | `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | 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`. | |
21
+ | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
22
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**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.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
23
+ | `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**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. | [default to false] |
24
+ | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
25
+ | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
26
+ | `metadata` | ```Hash<String, Object>``` | 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&#39;s order number for look up when receiving events for the signature request.<br><br>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. | |
27
+ | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
28
+ | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | |
29
+ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
30
+ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
31
+ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
32
+ | `use_text_tags` | ```Boolean``` | 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`. | [default to false] |
33
+ | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |
34
+
@@ -0,0 +1,25 @@
1
+ # Dropbox::Sign::SignatureRequestEditWithTemplateRequest
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `template_ids`<sup>*_required_</sup> | ```Array<String>``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | |
10
+ | `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestTemplateSigner>```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | |
11
+ | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
12
+ | `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
13
+ | `client_id` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | |
14
+ | `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
15
+ | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
16
+ | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
17
+ | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
18
+ | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
19
+ | `metadata` | ```Hash<String, Object>``` | 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&#39;s order number for look up when receiving events for the signature request.<br><br>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. | |
20
+ | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
21
+ | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | |
22
+ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
23
+ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
24
+ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
25
+
data/docs/TeamApi.md CHANGED
@@ -27,26 +27,28 @@ Invites a user (specified using the `email_address` parameter) to your Team. If
27
27
  ### Examples
28
28
 
29
29
  ```ruby
30
+ require "json"
30
31
  require "dropbox-sign"
31
32
 
32
33
  Dropbox::Sign.configure do |config|
33
- # Configure HTTP basic authorization: api_key
34
34
  config.username = "YOUR_API_KEY"
35
-
36
- # or, configure Bearer (JWT) authorization: oauth2
37
35
  # config.access_token = "YOUR_ACCESS_TOKEN"
38
36
  end
39
37
 
40
- team_api = Dropbox::Sign::TeamApi.new
41
-
42
- data = Dropbox::Sign::TeamAddMemberRequest.new
43
- data.email_address = "george@example.com"
38
+ team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new
39
+ team_add_member_request.email_address = "george@example.com"
44
40
 
45
41
  begin
46
- result = team_api.team_add_member(data)
47
- p result
42
+ response = Dropbox::Sign::TeamApi.new.team_add_member(
43
+ team_add_member_request,
44
+ {
45
+ team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c",
46
+ },
47
+ )
48
+
49
+ p response
48
50
  rescue Dropbox::Sign::ApiError => e
49
- puts "Exception when calling Dropbox Sign API: #{e}"
51
+ puts "Exception when calling TeamApi#team_add_member: #{e}"
50
52
  end
51
53
 
52
54
  ```
@@ -101,26 +103,25 @@ Creates a new Team and makes you a member. You must not currently belong to a Te
101
103
  ### Examples
102
104
 
103
105
  ```ruby
106
+ require "json"
104
107
  require "dropbox-sign"
105
108
 
106
109
  Dropbox::Sign.configure do |config|
107
- # Configure HTTP basic authorization: api_key
108
110
  config.username = "YOUR_API_KEY"
109
-
110
- # or, configure Bearer (JWT) authorization: oauth2
111
111
  # config.access_token = "YOUR_ACCESS_TOKEN"
112
112
  end
113
113
 
114
- team_api = Dropbox::Sign::TeamApi.new
115
-
116
- data = Dropbox::Sign::TeamCreateRequest.new
117
- data.name = "New Team Name"
114
+ team_create_request = Dropbox::Sign::TeamCreateRequest.new
115
+ team_create_request.name = "New Team Name"
118
116
 
119
117
  begin
120
- result = team_api.team_create(data)
121
- p result
118
+ response = Dropbox::Sign::TeamApi.new.team_create(
119
+ team_create_request,
120
+ )
121
+
122
+ p response
122
123
  rescue Dropbox::Sign::ApiError => e
123
- puts "Exception when calling Dropbox Sign API: #{e}"
124
+ puts "Exception when calling TeamApi#team_create: #{e}"
124
125
  end
125
126
 
126
127
  ```
@@ -174,23 +175,18 @@ Deletes your Team. Can only be invoked when you have a Team with only one member
174
175
  ### Examples
175
176
 
176
177
  ```ruby
178
+ require "json"
177
179
  require "dropbox-sign"
178
180
 
179
181
  Dropbox::Sign.configure do |config|
180
- # Configure HTTP basic authorization: api_key
181
182
  config.username = "YOUR_API_KEY"
182
-
183
- # or, configure Bearer (JWT) authorization: oauth2
184
183
  # config.access_token = "YOUR_ACCESS_TOKEN"
185
184
  end
186
185
 
187
- team_api = Dropbox::Sign::TeamApi.new
188
-
189
186
  begin
190
- result = team_api.team_delete
191
- p result
187
+ Dropbox::Sign::TeamApi.new.team_delete
192
188
  rescue Dropbox::Sign::ApiError => e
193
- puts "Exception when calling Dropbox Sign API: #{e}"
189
+ puts "Exception when calling TeamApi#team_delete: #{e}"
194
190
  end
195
191
 
196
192
  ```
@@ -242,23 +238,20 @@ Returns information about your Team as well as a list of its members. If you do
242
238
  ### Examples
243
239
 
244
240
  ```ruby
241
+ require "json"
245
242
  require "dropbox-sign"
246
243
 
247
244
  Dropbox::Sign.configure do |config|
248
- # Configure HTTP basic authorization: api_key
249
245
  config.username = "YOUR_API_KEY"
250
-
251
- # or, configure Bearer (JWT) authorization: oauth2
252
246
  # config.access_token = "YOUR_ACCESS_TOKEN"
253
247
  end
254
248
 
255
- team_api = Dropbox::Sign::TeamApi.new
256
-
257
249
  begin
258
- result = team_api.team_get
259
- p result
250
+ response = Dropbox::Sign::TeamApi.new.team_get
251
+
252
+ p response
260
253
  rescue Dropbox::Sign::ApiError => e
261
- puts "Exception when calling Dropbox Sign API: #{e}"
254
+ puts "Exception when calling TeamApi#team_get: #{e}"
262
255
  end
263
256
 
264
257
  ```
@@ -310,23 +303,24 @@ Provides information about a team.
310
303
  ### Examples
311
304
 
312
305
  ```ruby
306
+ require "json"
313
307
  require "dropbox-sign"
314
308
 
315
309
  Dropbox::Sign.configure do |config|
316
- # Configure HTTP basic authorization: api_key
317
310
  config.username = "YOUR_API_KEY"
318
-
319
- # or, configure Bearer (JWT) authorization: oauth2
320
311
  # config.access_token = "YOUR_ACCESS_TOKEN"
321
312
  end
322
313
 
323
- team_api = Dropbox::Sign::TeamApi.new
324
-
325
314
  begin
326
- result = team_api.team_info
327
- p result
315
+ response = Dropbox::Sign::TeamApi.new.team_info(
316
+ {
317
+ team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c",
318
+ },
319
+ )
320
+
321
+ p response
328
322
  rescue Dropbox::Sign::ApiError => e
329
- puts "Exception when calling Dropbox Sign API: #{e}"
323
+ puts "Exception when calling TeamApi#team_info: #{e}"
330
324
  end
331
325
 
332
326
  ```
@@ -380,25 +374,20 @@ Provides a list of team invites (and their roles).
380
374
  ### Examples
381
375
 
382
376
  ```ruby
377
+ require "json"
383
378
  require "dropbox-sign"
384
379
 
385
380
  Dropbox::Sign.configure do |config|
386
- # Configure HTTP basic authorization: api_key
387
381
  config.username = "YOUR_API_KEY"
388
-
389
- # or, configure Bearer (JWT) authorization: oauth2
390
382
  # config.access_token = "YOUR_ACCESS_TOKEN"
391
383
  end
392
384
 
393
- team_api = Dropbox::Sign::TeamApi.new
394
-
395
- email_address = "user@dropboxsign.com"
396
-
397
385
  begin
398
- result = team_api.team_invites({ email_address: email_address })
399
- p result
386
+ response = Dropbox::Sign::TeamApi.new.team_invites
387
+
388
+ p response
400
389
  rescue Dropbox::Sign::ApiError => e
401
- puts "Exception when calling Dropbox Sign API: #{e}"
390
+ puts "Exception when calling TeamApi#team_invites: #{e}"
402
391
  end
403
392
 
404
393
  ```
@@ -452,25 +441,26 @@ Provides a paginated list of members (and their roles) that belong to a given te
452
441
  ### Examples
453
442
 
454
443
  ```ruby
444
+ require "json"
455
445
  require "dropbox-sign"
456
446
 
457
447
  Dropbox::Sign.configure do |config|
458
- # Configure HTTP basic authorization: api_key
459
448
  config.username = "YOUR_API_KEY"
460
-
461
- # or, configure Bearer (JWT) authorization: oauth2
462
449
  # config.access_token = "YOUR_ACCESS_TOKEN"
463
450
  end
464
451
 
465
- team_api = Dropbox::Sign::TeamApi.new
466
-
467
- team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"
468
-
469
452
  begin
470
- result = team_api.team_members(team_id)
471
- p result
453
+ response = Dropbox::Sign::TeamApi.new.team_members(
454
+ "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id
455
+ {
456
+ page: 1,
457
+ page_size: 20,
458
+ },
459
+ )
460
+
461
+ p response
472
462
  rescue Dropbox::Sign::ApiError => e
473
- puts "Exception when calling Dropbox Sign API: #{e}"
463
+ puts "Exception when calling TeamApi#team_members: #{e}"
474
464
  end
475
465
 
476
466
  ```
@@ -526,27 +516,26 @@ Removes the provided user Account from your Team. If the Account had an outstand
526
516
  ### Examples
527
517
 
528
518
  ```ruby
519
+ require "json"
529
520
  require "dropbox-sign"
530
521
 
531
522
  Dropbox::Sign.configure do |config|
532
- # Configure HTTP basic authorization: api_key
533
523
  config.username = "YOUR_API_KEY"
534
-
535
- # or, configure Bearer (JWT) authorization: oauth2
536
524
  # config.access_token = "YOUR_ACCESS_TOKEN"
537
525
  end
538
526
 
539
- team_api = Dropbox::Sign::TeamApi.new
540
-
541
- data = Dropbox::Sign::TeamRemoveMemberRequest.new
542
- data.email_address = "teammate@dropboxsign.com"
543
- data.new_owner_email_address = "new_teammate@dropboxsign.com"
527
+ team_remove_member_request = Dropbox::Sign::TeamRemoveMemberRequest.new
528
+ team_remove_member_request.email_address = "teammate@dropboxsign.com"
529
+ team_remove_member_request.new_owner_email_address = "new_teammate@dropboxsign.com"
544
530
 
545
531
  begin
546
- result = team_api.team_remove_member(data)
547
- p result
532
+ response = Dropbox::Sign::TeamApi.new.team_remove_member(
533
+ team_remove_member_request,
534
+ )
535
+
536
+ p response
548
537
  rescue Dropbox::Sign::ApiError => e
549
- puts "Exception when calling Dropbox Sign API: #{e}"
538
+ puts "Exception when calling TeamApi#team_remove_member: #{e}"
550
539
  end
551
540
 
552
541
  ```
@@ -600,25 +589,26 @@ Provides a paginated list of sub teams that belong to a given team.
600
589
  ### Examples
601
590
 
602
591
  ```ruby
592
+ require "json"
603
593
  require "dropbox-sign"
604
594
 
605
595
  Dropbox::Sign.configure do |config|
606
- # Configure HTTP basic authorization: api_key
607
596
  config.username = "YOUR_API_KEY"
608
-
609
- # or, configure Bearer (JWT) authorization: oauth2
610
597
  # config.access_token = "YOUR_ACCESS_TOKEN"
611
598
  end
612
599
 
613
- team_api = Dropbox::Sign::TeamApi.new
614
-
615
- team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"
616
-
617
600
  begin
618
- result = team_api.team_sub_teams(team_id)
619
- p result
601
+ response = Dropbox::Sign::TeamApi.new.team_sub_teams(
602
+ "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id
603
+ {
604
+ page: 1,
605
+ page_size: 20,
606
+ },
607
+ )
608
+
609
+ p response
620
610
  rescue Dropbox::Sign::ApiError => e
621
- puts "Exception when calling Dropbox Sign API: #{e}"
611
+ puts "Exception when calling TeamApi#team_sub_teams: #{e}"
622
612
  end
623
613
 
624
614
  ```
@@ -674,26 +664,25 @@ Updates the name of your Team.
674
664
  ### Examples
675
665
 
676
666
  ```ruby
667
+ require "json"
677
668
  require "dropbox-sign"
678
669
 
679
670
  Dropbox::Sign.configure do |config|
680
- # Configure HTTP basic authorization: api_key
681
671
  config.username = "YOUR_API_KEY"
682
-
683
- # or, configure Bearer (JWT) authorization: oauth2
684
672
  # config.access_token = "YOUR_ACCESS_TOKEN"
685
673
  end
686
674
 
687
- team_api = Dropbox::Sign::TeamApi.new
688
-
689
- data = Dropbox::Sign::TeamUpdateRequest.new
690
- data.name = "New Team Name"
675
+ team_update_request = Dropbox::Sign::TeamUpdateRequest.new
676
+ team_update_request.name = "New Team Name"
691
677
 
692
678
  begin
693
- result = team_api.team_update(data)
694
- p result
679
+ response = Dropbox::Sign::TeamApi.new.team_update(
680
+ team_update_request,
681
+ )
682
+
683
+ p response
695
684
  rescue Dropbox::Sign::ApiError => e
696
- puts "Exception when calling Dropbox Sign API: #{e}"
685
+ puts "Exception when calling TeamApi#team_update: #{e}"
697
686
  end
698
687
 
699
688
  ```