dropbox-sign 1.0.0.pre.beta2301

Sign up to get free protection for your applications and to get access to all the features.
Files changed (552) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +10 -0
  3. data/Gemfile.lock +78 -0
  4. data/LICENSE +21 -0
  5. data/README.md +333 -0
  6. data/Rakefile +10 -0
  7. data/bin/generate-examples.php +269 -0
  8. data/bin/php +16 -0
  9. data/bin/replace +11 -0
  10. data/bin/ruby +16 -0
  11. data/bin/scan_for +32 -0
  12. data/composer.json +10 -0
  13. data/composer.lock +246 -0
  14. data/docs/AccountApi.md +301 -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 +19 -0
  19. data/docs/AccountResponseQuotas.md +14 -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 +33 -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/EventCallbackRequest.md +13 -0
  49. data/docs/EventCallbackRequestEvent.md +13 -0
  50. data/docs/EventCallbackRequestEventMetadata.md +13 -0
  51. data/docs/FileResponse.md +11 -0
  52. data/docs/FileResponseDataUri.md +10 -0
  53. data/docs/ListInfoResponse.md +13 -0
  54. data/docs/OAuthApi.md +158 -0
  55. data/docs/OAuthTokenGenerateRequest.md +14 -0
  56. data/docs/OAuthTokenRefreshRequest.md +11 -0
  57. data/docs/OAuthTokenResponse.md +14 -0
  58. data/docs/ReportApi.md +83 -0
  59. data/docs/ReportCreateRequest.md +12 -0
  60. data/docs/ReportCreateResponse.md +11 -0
  61. data/docs/ReportResponse.md +13 -0
  62. data/docs/SignatureRequestApi.md +1377 -0
  63. data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +22 -0
  64. data/docs/SignatureRequestBulkSendWithTemplateRequest.md +22 -0
  65. data/docs/SignatureRequestCreateEmbeddedRequest.md +33 -0
  66. data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +24 -0
  67. data/docs/SignatureRequestGetResponse.md +11 -0
  68. data/docs/SignatureRequestListResponse.md +12 -0
  69. data/docs/SignatureRequestRemindRequest.md +11 -0
  70. data/docs/SignatureRequestResponse.md +32 -0
  71. data/docs/SignatureRequestResponseAttachment.md +15 -0
  72. data/docs/SignatureRequestResponseCustomFieldBase.md +17 -0
  73. data/docs/SignatureRequestResponseCustomFieldCheckbox.md +11 -0
  74. data/docs/SignatureRequestResponseCustomFieldText.md +11 -0
  75. data/docs/SignatureRequestResponseCustomFieldTypeEnum.md +9 -0
  76. data/docs/SignatureRequestResponseDataBase.md +14 -0
  77. data/docs/SignatureRequestResponseDataTypeEnum.md +9 -0
  78. data/docs/SignatureRequestResponseDataValueCheckbox.md +11 -0
  79. data/docs/SignatureRequestResponseDataValueCheckboxMerge.md +11 -0
  80. data/docs/SignatureRequestResponseDataValueDateSigned.md +11 -0
  81. data/docs/SignatureRequestResponseDataValueDropdown.md +11 -0
  82. data/docs/SignatureRequestResponseDataValueInitials.md +11 -0
  83. data/docs/SignatureRequestResponseDataValueRadio.md +11 -0
  84. data/docs/SignatureRequestResponseDataValueSignature.md +11 -0
  85. data/docs/SignatureRequestResponseDataValueText.md +11 -0
  86. data/docs/SignatureRequestResponseDataValueTextMerge.md +11 -0
  87. data/docs/SignatureRequestResponseSignatures.md +28 -0
  88. data/docs/SignatureRequestSendRequest.md +34 -0
  89. data/docs/SignatureRequestSendWithTemplateRequest.md +25 -0
  90. data/docs/SignatureRequestUpdateRequest.md +13 -0
  91. data/docs/SubAttachment.md +13 -0
  92. data/docs/SubBulkSignerList.md +11 -0
  93. data/docs/SubBulkSignerListCustomField.md +11 -0
  94. data/docs/SubCC.md +11 -0
  95. data/docs/SubCustomField.md +17 -0
  96. data/docs/SubEditorOptions.md +11 -0
  97. data/docs/SubFieldOptions.md +10 -0
  98. data/docs/SubFormFieldGroup.md +12 -0
  99. data/docs/SubFormFieldRule.md +13 -0
  100. data/docs/SubFormFieldRuleAction.md +13 -0
  101. data/docs/SubFormFieldRuleTrigger.md +13 -0
  102. data/docs/SubFormFieldsPerDocumentBase.md +33 -0
  103. data/docs/SubFormFieldsPerDocumentCheckbox.md +12 -0
  104. data/docs/SubFormFieldsPerDocumentCheckboxMerge.md +10 -0
  105. data/docs/SubFormFieldsPerDocumentDateSigned.md +10 -0
  106. data/docs/SubFormFieldsPerDocumentDropdown.md +12 -0
  107. data/docs/SubFormFieldsPerDocumentHyperlink.md +12 -0
  108. data/docs/SubFormFieldsPerDocumentInitials.md +10 -0
  109. data/docs/SubFormFieldsPerDocumentRadio.md +12 -0
  110. data/docs/SubFormFieldsPerDocumentSignature.md +10 -0
  111. data/docs/SubFormFieldsPerDocumentText.md +17 -0
  112. data/docs/SubFormFieldsPerDocumentTextMerge.md +10 -0
  113. data/docs/SubFormFieldsPerDocumentTypeEnum.md +9 -0
  114. data/docs/SubMergeField.md +11 -0
  115. data/docs/SubOAuth.md +11 -0
  116. data/docs/SubOptions.md +10 -0
  117. data/docs/SubSignatureRequestGroupedSigners.md +12 -0
  118. data/docs/SubSignatureRequestSigner.md +15 -0
  119. data/docs/SubSignatureRequestTemplateSigner.md +15 -0
  120. data/docs/SubSigningOptions.md +16 -0
  121. data/docs/SubTeamResponse.md +11 -0
  122. data/docs/SubTemplateRole.md +11 -0
  123. data/docs/SubUnclaimedDraftSigner.md +12 -0
  124. data/docs/SubUnclaimedDraftTemplateSigner.md +12 -0
  125. data/docs/SubWhiteLabelingOptions.md +26 -0
  126. data/docs/TeamAddMemberRequest.md +12 -0
  127. data/docs/TeamApi.md +737 -0
  128. data/docs/TeamCreateRequest.md +10 -0
  129. data/docs/TeamGetInfoResponse.md +11 -0
  130. data/docs/TeamGetResponse.md +11 -0
  131. data/docs/TeamInfoResponse.md +14 -0
  132. data/docs/TeamInviteResponse.md +15 -0
  133. data/docs/TeamInvitesResponse.md +11 -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 +782 -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 +45 -0
  168. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +38 -0
  169. data/docs/UnclaimedDraftCreateRequest.md +33 -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/dropbox-sign.gemspec +38 -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/EventCallback.rb +32 -0
  189. data/examples/OauthTokenGenerate.rb +24 -0
  190. data/examples/OauthTokenRefresh.rb +21 -0
  191. data/examples/ReportCreate.rb +23 -0
  192. data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
  193. data/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
  194. data/examples/SignatureRequestCancel.rb +20 -0
  195. data/examples/SignatureRequestCreateEmbedded.rb +46 -0
  196. data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
  197. data/examples/SignatureRequestFiles.rb +20 -0
  198. data/examples/SignatureRequestFilesAsDataUri.rb +20 -0
  199. data/examples/SignatureRequestFilesAsFileUrl.rb +20 -0
  200. data/examples/SignatureRequestGet.rb +20 -0
  201. data/examples/SignatureRequestList.rb +21 -0
  202. data/examples/SignatureRequestReleaseHold.rb +20 -0
  203. data/examples/SignatureRequestRemind.rb +23 -0
  204. data/examples/SignatureRequestRemove.rb +20 -0
  205. data/examples/SignatureRequestSend.rb +56 -0
  206. data/examples/SignatureRequestSendWithTemplate.rb +50 -0
  207. data/examples/SignatureRequestUpdate.rb +24 -0
  208. data/examples/TeamAddMember.rb +21 -0
  209. data/examples/TeamCreate.rb +21 -0
  210. data/examples/TeamDelete.rb +18 -0
  211. data/examples/TeamGet.rb +18 -0
  212. data/examples/TeamInfo.rb +18 -0
  213. data/examples/TeamInvites.rb +20 -0
  214. data/examples/TeamMembers.rb +20 -0
  215. data/examples/TeamRemoveMember.rb +22 -0
  216. data/examples/TeamSubTeams.rb +20 -0
  217. data/examples/TeamUpdate.rb +21 -0
  218. data/examples/TemplateAddUser.rb +23 -0
  219. data/examples/TemplateCreateEmbeddedDraft.rb +49 -0
  220. data/examples/TemplateDelete.rb +20 -0
  221. data/examples/TemplateFiles.rb +20 -0
  222. data/examples/TemplateFilesAsDataUri.rb +20 -0
  223. data/examples/TemplateFilesAsFileUrl.rb +20 -0
  224. data/examples/TemplateGet.rb +20 -0
  225. data/examples/TemplateList.rb +20 -0
  226. data/examples/TemplateRemoveUser.rb +23 -0
  227. data/examples/TemplateUpdateFiles.rb +23 -0
  228. data/examples/UnclaimedDraftCreate.rb +56 -0
  229. data/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
  230. data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
  231. data/examples/UnclaimedDraftEditAndResend.rb +24 -0
  232. data/lib/dropbox-sign/api/account_api.rb +446 -0
  233. data/lib/dropbox-sign/api/api_app_api.rb +504 -0
  234. data/lib/dropbox-sign/api/bulk_send_job_api.rb +213 -0
  235. data/lib/dropbox-sign/api/embedded_api.rb +234 -0
  236. data/lib/dropbox-sign/api/o_auth_api.rb +215 -0
  237. data/lib/dropbox-sign/api/report_api.rb +134 -0
  238. data/lib/dropbox-sign/api/signature_request_api.rb +1620 -0
  239. data/lib/dropbox-sign/api/team_api.rb +1011 -0
  240. data/lib/dropbox-sign/api/template_api.rb +1037 -0
  241. data/lib/dropbox-sign/api/unclaimed_draft_api.rb +467 -0
  242. data/lib/dropbox-sign/api_client.rb +417 -0
  243. data/lib/dropbox-sign/api_error.rb +60 -0
  244. data/lib/dropbox-sign/configuration.rb +303 -0
  245. data/lib/dropbox-sign/event_callback_helper.rb +54 -0
  246. data/lib/dropbox-sign/models/account_create_request.rb +285 -0
  247. data/lib/dropbox-sign/models/account_create_response.rb +270 -0
  248. data/lib/dropbox-sign/models/account_get_response.rb +261 -0
  249. data/lib/dropbox-sign/models/account_response.rb +343 -0
  250. data/lib/dropbox-sign/models/account_response_quotas.rb +296 -0
  251. data/lib/dropbox-sign/models/account_update_request.rb +271 -0
  252. data/lib/dropbox-sign/models/account_verify_request.rb +255 -0
  253. data/lib/dropbox-sign/models/account_verify_response.rb +261 -0
  254. data/lib/dropbox-sign/models/account_verify_response_account.rb +250 -0
  255. data/lib/dropbox-sign/models/api_app_create_request.rb +347 -0
  256. data/lib/dropbox-sign/models/api_app_get_response.rb +261 -0
  257. data/lib/dropbox-sign/models/api_app_list_response.rb +273 -0
  258. data/lib/dropbox-sign/models/api_app_response.rb +343 -0
  259. data/lib/dropbox-sign/models/api_app_response_o_auth.rb +283 -0
  260. data/lib/dropbox-sign/models/api_app_response_options.rb +251 -0
  261. data/lib/dropbox-sign/models/api_app_response_owner_account.rb +261 -0
  262. data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +367 -0
  263. data/lib/dropbox-sign/models/api_app_update_request.rb +324 -0
  264. data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +282 -0
  265. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +503 -0
  266. data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +273 -0
  267. data/lib/dropbox-sign/models/bulk_send_job_response.rb +282 -0
  268. data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +261 -0
  269. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +357 -0
  270. data/lib/dropbox-sign/models/embedded_edit_url_response.rb +261 -0
  271. data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +261 -0
  272. data/lib/dropbox-sign/models/embedded_sign_url_response.rb +261 -0
  273. data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +261 -0
  274. data/lib/dropbox-sign/models/error_response.rb +254 -0
  275. data/lib/dropbox-sign/models/error_response_error.rb +281 -0
  276. data/lib/dropbox-sign/models/event_callback_request.rb +281 -0
  277. data/lib/dropbox-sign/models/event_callback_request_event.rb +334 -0
  278. data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +285 -0
  279. data/lib/dropbox-sign/models/file_response.rb +260 -0
  280. data/lib/dropbox-sign/models/file_response_data_uri.rb +250 -0
  281. data/lib/dropbox-sign/models/list_info_response.rb +282 -0
  282. data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +317 -0
  283. data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +272 -0
  284. data/lib/dropbox-sign/models/o_auth_token_response.rb +287 -0
  285. data/lib/dropbox-sign/models/report_create_request.rb +319 -0
  286. data/lib/dropbox-sign/models/report_create_response.rb +261 -0
  287. data/lib/dropbox-sign/models/report_response.rb +305 -0
  288. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +445 -0
  289. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +440 -0
  290. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +569 -0
  291. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +475 -0
  292. data/lib/dropbox-sign/models/signature_request_get_response.rb +261 -0
  293. data/lib/dropbox-sign/models/signature_request_list_response.rb +273 -0
  294. data/lib/dropbox-sign/models/signature_request_remind_request.rb +265 -0
  295. data/lib/dropbox-sign/models/signature_request_response.rb +494 -0
  296. data/lib/dropbox-sign/models/signature_request_response_attachment.rb +323 -0
  297. data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +316 -0
  298. data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +272 -0
  299. data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +272 -0
  300. data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +40 -0
  301. data/lib/dropbox-sign/models/signature_request_response_data_base.rb +326 -0
  302. data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +47 -0
  303. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +266 -0
  304. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +266 -0
  305. data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +266 -0
  306. data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +266 -0
  307. data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +266 -0
  308. data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +266 -0
  309. data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +266 -0
  310. data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +266 -0
  311. data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +266 -0
  312. data/lib/dropbox-sign/models/signature_request_response_signatures.rb +446 -0
  313. data/lib/dropbox-sign/models/signature_request_send_request.rb +574 -0
  314. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +480 -0
  315. data/lib/dropbox-sign/models/signature_request_update_request.rb +286 -0
  316. data/lib/dropbox-sign/models/sub_attachment.rb +292 -0
  317. data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +264 -0
  318. data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +270 -0
  319. data/lib/dropbox-sign/models/sub_cc.rb +270 -0
  320. data/lib/dropbox-sign/models/sub_custom_field.rb +288 -0
  321. data/lib/dropbox-sign/models/sub_editor_options.rb +265 -0
  322. data/lib/dropbox-sign/models/sub_field_options.rb +290 -0
  323. data/lib/dropbox-sign/models/sub_form_field_group.rb +285 -0
  324. data/lib/dropbox-sign/models/sub_form_field_rule.rb +353 -0
  325. data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +323 -0
  326. data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +326 -0
  327. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +435 -0
  328. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +287 -0
  329. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +262 -0
  330. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +262 -0
  331. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +308 -0
  332. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +292 -0
  333. data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +262 -0
  334. data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +292 -0
  335. data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +262 -0
  336. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +364 -0
  337. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +262 -0
  338. data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +48 -0
  339. data/lib/dropbox-sign/models/sub_merge_field.rb +304 -0
  340. data/lib/dropbox-sign/models/sub_o_auth.rb +285 -0
  341. data/lib/dropbox-sign/models/sub_options.rb +253 -0
  342. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +283 -0
  343. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +369 -0
  344. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +373 -0
  345. data/lib/dropbox-sign/models/sub_signing_options.rb +338 -0
  346. data/lib/dropbox-sign/models/sub_team_response.rb +260 -0
  347. data/lib/dropbox-sign/models/sub_template_role.rb +261 -0
  348. data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +281 -0
  349. data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +285 -0
  350. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +439 -0
  351. data/lib/dropbox-sign/models/team_add_member_request.rb +304 -0
  352. data/lib/dropbox-sign/models/team_create_request.rb +252 -0
  353. data/lib/dropbox-sign/models/team_get_info_response.rb +261 -0
  354. data/lib/dropbox-sign/models/team_get_response.rb +261 -0
  355. data/lib/dropbox-sign/models/team_info_response.rb +290 -0
  356. data/lib/dropbox-sign/models/team_invite_response.rb +300 -0
  357. data/lib/dropbox-sign/models/team_invites_response.rb +263 -0
  358. data/lib/dropbox-sign/models/team_member_response.rb +270 -0
  359. data/lib/dropbox-sign/models/team_members_response.rb +272 -0
  360. data/lib/dropbox-sign/models/team_parent_response.rb +261 -0
  361. data/lib/dropbox-sign/models/team_remove_member_request.rb +324 -0
  362. data/lib/dropbox-sign/models/team_response.rb +274 -0
  363. data/lib/dropbox-sign/models/team_sub_teams_response.rb +272 -0
  364. data/lib/dropbox-sign/models/team_update_request.rb +250 -0
  365. data/lib/dropbox-sign/models/template_add_user_request.rb +272 -0
  366. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +567 -0
  367. data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +261 -0
  368. data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +283 -0
  369. data/lib/dropbox-sign/models/template_edit_response.rb +250 -0
  370. data/lib/dropbox-sign/models/template_get_response.rb +261 -0
  371. data/lib/dropbox-sign/models/template_list_response.rb +273 -0
  372. data/lib/dropbox-sign/models/template_remove_user_request.rb +260 -0
  373. data/lib/dropbox-sign/models/template_response.rb +410 -0
  374. data/lib/dropbox-sign/models/template_response_account.rb +299 -0
  375. data/lib/dropbox-sign/models/template_response_account_quota.rb +281 -0
  376. data/lib/dropbox-sign/models/template_response_cc_role.rb +250 -0
  377. data/lib/dropbox-sign/models/template_response_custom_field.rb +407 -0
  378. data/lib/dropbox-sign/models/template_response_document.rb +309 -0
  379. data/lib/dropbox-sign/models/template_response_document_custom_field.rb +438 -0
  380. data/lib/dropbox-sign/models/template_response_document_field_group.rb +260 -0
  381. data/lib/dropbox-sign/models/template_response_document_form_field.rb +417 -0
  382. data/lib/dropbox-sign/models/template_response_document_static_field.rb +341 -0
  383. data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +261 -0
  384. data/lib/dropbox-sign/models/template_response_named_form_field.rb +383 -0
  385. data/lib/dropbox-sign/models/template_response_signer_role.rb +260 -0
  386. data/lib/dropbox-sign/models/template_update_files_request.rb +336 -0
  387. data/lib/dropbox-sign/models/template_update_files_response.rb +249 -0
  388. data/lib/dropbox-sign/models/template_update_files_response_template.rb +263 -0
  389. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +728 -0
  390. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +631 -0
  391. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +586 -0
  392. data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +261 -0
  393. data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +328 -0
  394. data/lib/dropbox-sign/models/unclaimed_draft_response.rb +305 -0
  395. data/lib/dropbox-sign/models/warning_response.rb +271 -0
  396. data/lib/dropbox-sign/version.rb +18 -0
  397. data/lib/dropbox-sign.rb +204 -0
  398. data/openapi-config.yaml +21 -0
  399. data/openapi-sdk.yaml +11080 -0
  400. data/run-build +53 -0
  401. data/spec/api/account_api_spec.rb +107 -0
  402. data/spec/api/api_app_api_spec.rb +95 -0
  403. data/spec/api/bulk_send_job_api_spec.rb +52 -0
  404. data/spec/api/embedded_api_spec.rb +55 -0
  405. data/spec/api/oauth_api_spec.rb +55 -0
  406. data/spec/api/report_api_spec.rb +38 -0
  407. data/spec/api/signature_request_api_spec.rb +263 -0
  408. data/spec/api/team_api_spec.rb +105 -0
  409. data/spec/api/template_api_spec.rb +147 -0
  410. data/spec/api/unclaimed_draft_api_spec.rb +95 -0
  411. data/spec/api_client_spec.rb +226 -0
  412. data/spec/configuration_spec.rb +42 -0
  413. data/spec/event_callback_helper_spec.rb +22 -0
  414. data/spec/fixtures_spec.rb +59 -0
  415. data/spec/models/sub_form_fields_per_document_base_spec.rb +24 -0
  416. data/spec/spec_helper.rb +111 -0
  417. data/spec/test_utils.rb +19 -0
  418. data/templates/Gemfile.mustache +10 -0
  419. data/templates/README.mustache +133 -0
  420. data/templates/Rakefile.mustache +10 -0
  421. data/templates/api.mustache +283 -0
  422. data/templates/api_client.mustache +291 -0
  423. data/templates/api_client_faraday_partial.mustache +136 -0
  424. data/templates/api_client_spec.mustache +220 -0
  425. data/templates/api_client_typhoeus_partial.mustache +153 -0
  426. data/templates/api_doc.mustache +77 -0
  427. data/templates/api_error.mustache +52 -0
  428. data/templates/api_info.mustache +12 -0
  429. data/templates/api_test.mustache +47 -0
  430. data/templates/base_object.mustache +132 -0
  431. data/templates/configuration.mustache +372 -0
  432. data/templates/configuration_spec.mustache +34 -0
  433. data/templates/configuration_tls_faraday_partial.mustache +29 -0
  434. data/templates/configuration_tls_typhoeus_partial.mustache +34 -0
  435. data/templates/event_callback_helper.mustache +46 -0
  436. data/templates/gem.mustache +55 -0
  437. data/templates/gemspec.mustache +35 -0
  438. data/templates/git_push.sh.mustache +57 -0
  439. data/templates/gitignore.mustache +41 -0
  440. data/templates/model.mustache +29 -0
  441. data/templates/model_doc.mustache +12 -0
  442. data/templates/model_test.mustache +77 -0
  443. data/templates/partial_model_enum_class.mustache +20 -0
  444. data/templates/partial_model_generic.mustache +414 -0
  445. data/templates/partial_model_generic_doc.mustache +10 -0
  446. data/templates/partial_oneof_module.mustache +137 -0
  447. data/templates/partial_oneof_module_doc.mustache +92 -0
  448. data/templates/rspec.mustache +2 -0
  449. data/templates/rubocop.mustache +148 -0
  450. data/templates/spec_helper.mustache +103 -0
  451. data/templates/travis.mustache +14 -0
  452. data/templates/version.mustache +10 -0
  453. data/test_fixtures/AccountCreateRequest.json +7 -0
  454. data/test_fixtures/AccountCreateResponse.json +15 -0
  455. data/test_fixtures/AccountGetResponse.json +14 -0
  456. data/test_fixtures/AccountUpdateRequest.json +5 -0
  457. data/test_fixtures/AccountVerifyRequest.json +5 -0
  458. data/test_fixtures/AccountVerifyResponse.json +7 -0
  459. data/test_fixtures/ApiAppCreateRequest.json +35 -0
  460. data/test_fixtures/ApiAppGetResponse.json +27 -0
  461. data/test_fixtures/ApiAppListResponse.json +42 -0
  462. data/test_fixtures/ApiAppUpdateRequest.json +35 -0
  463. data/test_fixtures/BulkSendJobGetResponse.json +67 -0
  464. data/test_fixtures/BulkSendJobListResponse.json +24 -0
  465. data/test_fixtures/BulkSendJobSendResponse.json +10 -0
  466. data/test_fixtures/EmbeddedEditUrlRequest.json +28 -0
  467. data/test_fixtures/EmbeddedEditUrlResponse.json +8 -0
  468. data/test_fixtures/EmbeddedSignUrlResponse.json +8 -0
  469. data/test_fixtures/ErrorResponse.json +9 -0
  470. data/test_fixtures/EventCallbackHelper.json +50 -0
  471. data/test_fixtures/FileResponse.json +6 -0
  472. data/test_fixtures/OAuthTokenGenerateRequest.json +9 -0
  473. data/test_fixtures/OAuthTokenRefreshRequest.json +6 -0
  474. data/test_fixtures/OAuthTokenResponse.json +15 -0
  475. data/test_fixtures/ReportCreateRequest.json +10 -0
  476. data/test_fixtures/ReportCreateResponse.json +13 -0
  477. data/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +67 -0
  478. data/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +66 -0
  479. data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +252 -0
  480. data/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +60 -0
  481. data/test_fixtures/SignatureRequestGetResponse.json +146 -0
  482. data/test_fixtures/SignatureRequestListResponse.json +102 -0
  483. data/test_fixtures/SignatureRequestRemindRequest.json +5 -0
  484. data/test_fixtures/SignatureRequestSendRequest.json +463 -0
  485. data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +48 -0
  486. data/test_fixtures/SignatureRequestUpdateRequest.json +7 -0
  487. data/test_fixtures/SubFormFieldsPerDocument.json +107 -0
  488. data/test_fixtures/TeamAddMemberRequest.json +6 -0
  489. data/test_fixtures/TeamCreateRequest.json +5 -0
  490. data/test_fixtures/TeamGetResponse.json +34 -0
  491. data/test_fixtures/TeamRemoveMemberRequest.json +7 -0
  492. data/test_fixtures/TeamUpdateRequest.json +5 -0
  493. data/test_fixtures/TemplateAddUserRequest.json +7 -0
  494. data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +118 -0
  495. data/test_fixtures/TemplateCreateEmbeddedDraftResponse.json +9 -0
  496. data/test_fixtures/TemplateGetResponse.json +102 -0
  497. data/test_fixtures/TemplateListResponse.json +143 -0
  498. data/test_fixtures/TemplateRemoveUserRequest.json +6 -0
  499. data/test_fixtures/TemplateUpdateFilesRequest.json +11 -0
  500. data/test_fixtures/TemplateUpdateFilesResponse.json +7 -0
  501. data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +134 -0
  502. data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +67 -0
  503. data/test_fixtures/UnclaimedDraftCreateRequest.json +119 -0
  504. data/test_fixtures/UnclaimedDraftCreateResponse.json +9 -0
  505. data/test_fixtures/UnclaimedDraftEditAndResendRequest.json +15 -0
  506. data/test_fixtures/bulk-send-sample.csv +3 -0
  507. data/test_fixtures/pdf-sample-2.pdf +0 -0
  508. data/test_fixtures/pdf-sample.pdf +0 -0
  509. data/vendor/autoload.php +7 -0
  510. data/vendor/bin/yaml-lint +117 -0
  511. data/vendor/composer/ClassLoader.php +572 -0
  512. data/vendor/composer/InstalledVersions.php +350 -0
  513. data/vendor/composer/LICENSE +21 -0
  514. data/vendor/composer/autoload_classmap.php +10 -0
  515. data/vendor/composer/autoload_files.php +11 -0
  516. data/vendor/composer/autoload_namespaces.php +9 -0
  517. data/vendor/composer/autoload_psr4.php +11 -0
  518. data/vendor/composer/autoload_real.php +80 -0
  519. data/vendor/composer/autoload_static.php +46 -0
  520. data/vendor/composer/installed.json +239 -0
  521. data/vendor/composer/installed.php +50 -0
  522. data/vendor/composer/platform_check.php +26 -0
  523. data/vendor/symfony/deprecation-contracts/.gitignore +3 -0
  524. data/vendor/symfony/deprecation-contracts/CHANGELOG.md +5 -0
  525. data/vendor/symfony/deprecation-contracts/LICENSE +19 -0
  526. data/vendor/symfony/deprecation-contracts/README.md +26 -0
  527. data/vendor/symfony/deprecation-contracts/composer.json +35 -0
  528. data/vendor/symfony/deprecation-contracts/function.php +27 -0
  529. data/vendor/symfony/polyfill-ctype/Ctype.php +232 -0
  530. data/vendor/symfony/polyfill-ctype/LICENSE +19 -0
  531. data/vendor/symfony/polyfill-ctype/README.md +12 -0
  532. data/vendor/symfony/polyfill-ctype/bootstrap.php +50 -0
  533. data/vendor/symfony/polyfill-ctype/bootstrap80.php +46 -0
  534. data/vendor/symfony/polyfill-ctype/composer.json +41 -0
  535. data/vendor/symfony/yaml/CHANGELOG.md +237 -0
  536. data/vendor/symfony/yaml/Command/LintCommand.php +289 -0
  537. data/vendor/symfony/yaml/Dumper.php +140 -0
  538. data/vendor/symfony/yaml/Escaper.php +95 -0
  539. data/vendor/symfony/yaml/Exception/DumpException.php +21 -0
  540. data/vendor/symfony/yaml/Exception/ExceptionInterface.php +21 -0
  541. data/vendor/symfony/yaml/Exception/ParseException.php +132 -0
  542. data/vendor/symfony/yaml/Exception/RuntimeException.php +21 -0
  543. data/vendor/symfony/yaml/Inline.php +812 -0
  544. data/vendor/symfony/yaml/LICENSE +19 -0
  545. data/vendor/symfony/yaml/Parser.php +1305 -0
  546. data/vendor/symfony/yaml/README.md +13 -0
  547. data/vendor/symfony/yaml/Resources/bin/yaml-lint +45 -0
  548. data/vendor/symfony/yaml/Tag/TaggedValue.php +38 -0
  549. data/vendor/symfony/yaml/Unescaper.php +132 -0
  550. data/vendor/symfony/yaml/Yaml.php +100 -0
  551. data/vendor/symfony/yaml/composer.json +42 -0
  552. metadata +650 -0
@@ -0,0 +1,1377 @@
1
+ # Dropbox::Sign::SignatureRequestApi
2
+
3
+ All URIs are relative to *https://api.hellosign.com/v3*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [`signature_request_bulk_create_embedded_with_template`](SignatureRequestApi.md#signature_request_bulk_create_embedded_with_template) | **POST** `/signature_request/bulk_create_embedded_with_template` | Embedded Bulk Send with Template |
8
+ | [`signature_request_bulk_send_with_template`](SignatureRequestApi.md#signature_request_bulk_send_with_template) | **POST** `/signature_request/bulk_send_with_template` | Bulk Send with Template |
9
+ | [`signature_request_cancel`](SignatureRequestApi.md#signature_request_cancel) | **POST** `/signature_request/cancel/{signature_request_id}` | Cancel Incomplete Signature Request |
10
+ | [`signature_request_create_embedded`](SignatureRequestApi.md#signature_request_create_embedded) | **POST** `/signature_request/create_embedded` | Create Embedded Signature Request |
11
+ | [`signature_request_create_embedded_with_template`](SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** `/signature_request/create_embedded_with_template` | Create Embedded Signature Request with Template |
12
+ | [`signature_request_files`](SignatureRequestApi.md#signature_request_files) | **GET** `/signature_request/files/{signature_request_id}` | Download Files |
13
+ | [`signature_request_files_as_data_uri`](SignatureRequestApi.md#signature_request_files_as_data_uri) | **GET** `/signature_request/files_as_data_uri/{signature_request_id}` | Download Files as Data Uri |
14
+ | [`signature_request_files_as_file_url`](SignatureRequestApi.md#signature_request_files_as_file_url) | **GET** `/signature_request/files_as_file_url/{signature_request_id}` | Download Files as File Url |
15
+ | [`signature_request_get`](SignatureRequestApi.md#signature_request_get) | **GET** `/signature_request/{signature_request_id}` | Get Signature Request |
16
+ | [`signature_request_list`](SignatureRequestApi.md#signature_request_list) | **GET** `/signature_request/list` | List Signature Requests |
17
+ | [`signature_request_release_hold`](SignatureRequestApi.md#signature_request_release_hold) | **POST** `/signature_request/release_hold/{signature_request_id}` | Release On-Hold Signature Request |
18
+ | [`signature_request_remind`](SignatureRequestApi.md#signature_request_remind) | **POST** `/signature_request/remind/{signature_request_id}` | Send Request Reminder |
19
+ | [`signature_request_remove`](SignatureRequestApi.md#signature_request_remove) | **POST** `/signature_request/remove/{signature_request_id}` | Remove Signature Request Access |
20
+ | [`signature_request_send`](SignatureRequestApi.md#signature_request_send) | **POST** `/signature_request/send` | Send Signature Request |
21
+ | [`signature_request_send_with_template`](SignatureRequestApi.md#signature_request_send_with_template) | **POST** `/signature_request/send_with_template` | Send with Template |
22
+ | [`signature_request_update`](SignatureRequestApi.md#signature_request_update) | **POST** `/signature_request/update/{signature_request_id}` | Update Signature Request |
23
+
24
+
25
+ ## `signature_request_bulk_create_embedded_with_template`
26
+
27
+ > `<BulkSendJobSendResponse> signature_request_bulk_create_embedded_with_template(signature_request_bulk_create_embedded_with_template_request)`
28
+
29
+ Embedded Bulk Send with Template
30
+
31
+ 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 Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
32
+
33
+ ### Examples
34
+
35
+ ```ruby
36
+ require "dropbox-sign"
37
+
38
+ Dropbox::Sign.configure do |config|
39
+ # Configure HTTP basic authorization: api_key
40
+ config.username = "YOUR_API_KEY"
41
+
42
+ # or, configure Bearer (JWT) authorization: oauth2
43
+ # config.access_token = "YOUR_ACCESS_TOKEN"
44
+ end
45
+
46
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
47
+
48
+ signer_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
49
+ signer_list_1_signer.role = "Client"
50
+ signer_list_1_signer.name = "George"
51
+ signer_list_1_signer.email_address = "george@example.com"
52
+ signer_list_1_signer.pin = "d79a3td"
53
+
54
+ signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new
55
+ signer_list_1_custom_fields.name = "company"
56
+ signer_list_1_custom_fields.value = "ABC Corp"
57
+
58
+ signer_list_1 = Dropbox::Sign::SubBulkSignerList.new
59
+ signer_list_1.signers = [signer_list_1_signer]
60
+ signer_list_1.custom_fields = [signer_list_1_custom_fields]
61
+
62
+ signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
63
+ signer_list_2_signer.role = "Client"
64
+ signer_list_2_signer.name = "Mary"
65
+ signer_list_2_signer.email_address = "mary@example.com"
66
+ signer_list_2_signer.pin = "gd9as5b"
67
+
68
+ signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new
69
+ signer_list_2_custom_fields.name = "company"
70
+ signer_list_2_custom_fields.value = "123 LLC"
71
+
72
+ signer_list_2 = Dropbox::Sign::SubBulkSignerList.new
73
+ signer_list_2.signers = [signer_list_2_signer]
74
+ signer_list_2.custom_fields = [signer_list_2_custom_fields]
75
+
76
+ cc_1 = Dropbox::Sign::SubCC.new
77
+ cc_1.role = "Accounting"
78
+ cc_1.email_address = "accounting@example.com"
79
+
80
+ data = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new
81
+ data.client_id = "1a659d9ad95bccd307ecad78d72192f8"
82
+ data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]
83
+ data.subject = "Purchase Order"
84
+ data.message = "Glad we could come to an agreement."
85
+ data.signer_list = [signer_list_1, signer_list_2]
86
+ data.ccs = [cc_1]
87
+ data.test_mode = true
88
+
89
+ begin
90
+ result = signature_request_api.signature_request_bulk_create_embedded_with_template(data)
91
+ p result
92
+ rescue Dropbox::Sign::ApiError => e
93
+ puts "Exception when calling Dropbox Sign API: #{e}"
94
+ end
95
+
96
+ ```
97
+
98
+ #### Using the `signature_request_bulk_create_embedded_with_template_with_http_info` variant
99
+
100
+ This returns an Array which contains the response data, status code and headers.
101
+
102
+ > `<Array(<BulkSendJobSendResponse>, Integer, Hash)> signature_request_bulk_create_embedded_with_template_with_http_info(signature_request_bulk_create_embedded_with_template_request)`
103
+
104
+ ```ruby
105
+ begin
106
+ # Embedded Bulk Send with Template
107
+ data, status_code, headers = api_instance.signature_request_bulk_create_embedded_with_template_with_http_info(signature_request_bulk_create_embedded_with_template_request)
108
+ p status_code # => 2xx
109
+ p headers # => { ... }
110
+ p data # => <BulkSendJobSendResponse>
111
+ rescue Dropbox::Sign::ApiError => e
112
+ puts "Error when calling SignatureRequestApi->signature_request_bulk_create_embedded_with_template_with_http_info: #{e}"
113
+ end
114
+ ```
115
+
116
+ ### Parameters
117
+
118
+ | Name | Type | Description | Notes |
119
+ | ---- | ---- | ----------- | ----- |
120
+ | `signature_request_bulk_create_embedded_with_template_request` | [**SignatureRequestBulkCreateEmbeddedWithTemplateRequest**](SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md) | | |
121
+
122
+ ### Return type
123
+
124
+ [**BulkSendJobSendResponse**](BulkSendJobSendResponse.md)
125
+
126
+ ### Authorization
127
+
128
+ [api_key](../README.md#api_key)
129
+
130
+ ### HTTP request headers
131
+
132
+ - **Content-Type**: application/json, multipart/form-data
133
+ - **Accept**: application/json
134
+
135
+
136
+ ## `signature_request_bulk_send_with_template`
137
+
138
+ > `<BulkSendJobSendResponse> signature_request_bulk_send_with_template(signature_request_bulk_send_with_template_request)`
139
+
140
+ Bulk Send with Template
141
+
142
+ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
143
+
144
+ ### Examples
145
+
146
+ ```ruby
147
+ require "dropbox-sign"
148
+
149
+ Dropbox::Sign.configure do |config|
150
+ # Configure HTTP basic authorization: api_key
151
+ config.username = "YOUR_API_KEY"
152
+
153
+ # or, configure Bearer (JWT) authorization: oauth2
154
+ # config.access_token = "YOUR_ACCESS_TOKEN"
155
+ end
156
+
157
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
158
+
159
+ signer_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
160
+ signer_list_1_signer.role = "Client"
161
+ signer_list_1_signer.name = "George"
162
+ signer_list_1_signer.email_address = "george@example.com"
163
+ signer_list_1_signer.pin = "d79a3td"
164
+
165
+ signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new
166
+ signer_list_1_custom_fields.name = "company"
167
+ signer_list_1_custom_fields.value = "ABC Corp"
168
+
169
+ signer_list_1 = Dropbox::Sign::SubBulkSignerList.new
170
+ signer_list_1.signers = [signer_list_1_signer]
171
+ signer_list_1.custom_fields = [signer_list_1_custom_fields]
172
+
173
+ signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
174
+ signer_list_2_signer.role = "Client"
175
+ signer_list_2_signer.name = "Mary"
176
+ signer_list_2_signer.email_address = "mary@example.com"
177
+ signer_list_2_signer.pin = "gd9as5b"
178
+
179
+ signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new
180
+ signer_list_2_custom_fields.name = "company"
181
+ signer_list_2_custom_fields.value = "123 LLC"
182
+
183
+ signer_list_2 = Dropbox::Sign::SubBulkSignerList.new
184
+ signer_list_2.signers = [signer_list_2_signer]
185
+ signer_list_2.custom_fields = [signer_list_2_custom_fields]
186
+
187
+ cc_1 = Dropbox::Sign::SubCC.new
188
+ cc_1.role = "Accounting"
189
+ cc_1.email_address = "accounting@example.com"
190
+
191
+ data = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new
192
+ data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]
193
+ data.subject = "Purchase Order"
194
+ data.message = "Glad we could come to an agreement."
195
+ data.signer_list = [signer_list_1, signer_list_2]
196
+ data.ccs = [cc_1]
197
+ data.test_mode = true
198
+
199
+ begin
200
+ result = signature_request_api.signature_request_bulk_send_with_template(data)
201
+ p result
202
+ rescue Dropbox::Sign::ApiError => e
203
+ puts "Exception when calling Dropbox Sign API: #{e}"
204
+ end
205
+
206
+ ```
207
+
208
+ #### Using the `signature_request_bulk_send_with_template_with_http_info` variant
209
+
210
+ This returns an Array which contains the response data, status code and headers.
211
+
212
+ > `<Array(<BulkSendJobSendResponse>, Integer, Hash)> signature_request_bulk_send_with_template_with_http_info(signature_request_bulk_send_with_template_request)`
213
+
214
+ ```ruby
215
+ begin
216
+ # Bulk Send with Template
217
+ data, status_code, headers = api_instance.signature_request_bulk_send_with_template_with_http_info(signature_request_bulk_send_with_template_request)
218
+ p status_code # => 2xx
219
+ p headers # => { ... }
220
+ p data # => <BulkSendJobSendResponse>
221
+ rescue Dropbox::Sign::ApiError => e
222
+ puts "Error when calling SignatureRequestApi->signature_request_bulk_send_with_template_with_http_info: #{e}"
223
+ end
224
+ ```
225
+
226
+ ### Parameters
227
+
228
+ | Name | Type | Description | Notes |
229
+ | ---- | ---- | ----------- | ----- |
230
+ | `signature_request_bulk_send_with_template_request` | [**SignatureRequestBulkSendWithTemplateRequest**](SignatureRequestBulkSendWithTemplateRequest.md) | | |
231
+
232
+ ### Return type
233
+
234
+ [**BulkSendJobSendResponse**](BulkSendJobSendResponse.md)
235
+
236
+ ### Authorization
237
+
238
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
239
+
240
+ ### HTTP request headers
241
+
242
+ - **Content-Type**: application/json, multipart/form-data
243
+ - **Accept**: application/json
244
+
245
+
246
+ ## `signature_request_cancel`
247
+
248
+ > `signature_request_cancel(signature_request_id)`
249
+
250
+ Cancel Incomplete Signature Request
251
+
252
+ Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. 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. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
253
+
254
+ ### Examples
255
+
256
+ ```ruby
257
+ require "dropbox-sign"
258
+
259
+ Dropbox::Sign.configure do |config|
260
+ # Configure HTTP basic authorization: api_key
261
+ config.username = "YOUR_API_KEY"
262
+
263
+ # or, configure Bearer (JWT) authorization: oauth2
264
+ # config.access_token = "YOUR_ACCESS_TOKEN"
265
+ end
266
+
267
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
268
+
269
+ signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
270
+
271
+ begin
272
+ result = signature_request_api.signature_request_cancel(signature_request_id)
273
+ p result
274
+ rescue Dropbox::Sign::ApiError => e
275
+ puts "Exception when calling Dropbox Sign API: #{e}"
276
+ end
277
+
278
+ ```
279
+
280
+ #### Using the `signature_request_cancel_with_http_info` variant
281
+
282
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
283
+
284
+ > `<Array(nil, Integer, Hash)> signature_request_cancel_with_http_info(signature_request_id)`
285
+
286
+ ```ruby
287
+ begin
288
+ # Cancel Incomplete Signature Request
289
+ data, status_code, headers = api_instance.signature_request_cancel_with_http_info(signature_request_id)
290
+ p status_code # => 2xx
291
+ p headers # => { ... }
292
+ p data # => nil
293
+ rescue Dropbox::Sign::ApiError => e
294
+ puts "Error when calling SignatureRequestApi->signature_request_cancel_with_http_info: #{e}"
295
+ end
296
+ ```
297
+
298
+ ### Parameters
299
+
300
+ | Name | Type | Description | Notes |
301
+ | ---- | ---- | ----------- | ----- |
302
+ | `signature_request_id` | **String** | The id of the incomplete SignatureRequest to cancel. | |
303
+
304
+ ### Return type
305
+
306
+ nil (empty response body)
307
+
308
+ ### Authorization
309
+
310
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
311
+
312
+ ### HTTP request headers
313
+
314
+ - **Content-Type**: Not defined
315
+ - **Accept**: application/json
316
+
317
+
318
+ ## `signature_request_create_embedded`
319
+
320
+ > `<SignatureRequestGetResponse> signature_request_create_embedded(signature_request_create_embedded_request)`
321
+
322
+ Create Embedded Signature Request
323
+
324
+ 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 Dropbox Sign.
325
+
326
+ ### Examples
327
+
328
+ ```ruby
329
+ require "dropbox-sign"
330
+
331
+ Dropbox::Sign.configure do |config|
332
+ # Configure HTTP basic authorization: api_key
333
+ config.username = "YOUR_API_KEY"
334
+
335
+ # or, configure Bearer (JWT) authorization: oauth2
336
+ # config.access_token = "YOUR_ACCESS_TOKEN"
337
+ end
338
+
339
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
340
+
341
+ signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new
342
+ signer_1.email_address = "jack@example.com"
343
+ signer_1.name = "Jack"
344
+ signer_1.order = 0
345
+
346
+ signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new
347
+ signer_2.email_address = "jill@example.com"
348
+ signer_2.name = "Jill"
349
+ signer_2.order = 1
350
+
351
+ signing_options = Dropbox::Sign::SubSigningOptions.new
352
+ signing_options.draw = true
353
+ signing_options.type = true
354
+ signing_options.upload = true
355
+ signing_options.phone = true
356
+ signing_options.default_type = "draw"
357
+
358
+ data = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new
359
+ data.client_id = "ec64a202072370a737edf4a0eb7f4437"
360
+ data.title = "NDA with Acme Co."
361
+ data.subject = "The NDA we talked about"
362
+ data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
363
+ data.signers = [signer_1, signer_2]
364
+ data.cc_email_addresses = ["lawyer@dropboxsign.com", "lawyer@dropboxsign.com"]
365
+ data.files = [File.new("example_signature_request.pdf", "r")]
366
+ data.signing_options = signing_options
367
+ data.test_mode = true
368
+
369
+ begin
370
+ result = signature_request_api.signature_request_create_embedded(data)
371
+ p result
372
+ rescue Dropbox::Sign::ApiError => e
373
+ puts "Exception when calling Dropbox Sign API: #{e}"
374
+ end
375
+
376
+ ```
377
+
378
+ #### Using the `signature_request_create_embedded_with_http_info` variant
379
+
380
+ This returns an Array which contains the response data, status code and headers.
381
+
382
+ > `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_create_embedded_with_http_info(signature_request_create_embedded_request)`
383
+
384
+ ```ruby
385
+ begin
386
+ # Create Embedded Signature Request
387
+ data, status_code, headers = api_instance.signature_request_create_embedded_with_http_info(signature_request_create_embedded_request)
388
+ p status_code # => 2xx
389
+ p headers # => { ... }
390
+ p data # => <SignatureRequestGetResponse>
391
+ rescue Dropbox::Sign::ApiError => e
392
+ puts "Error when calling SignatureRequestApi->signature_request_create_embedded_with_http_info: #{e}"
393
+ end
394
+ ```
395
+
396
+ ### Parameters
397
+
398
+ | Name | Type | Description | Notes |
399
+ | ---- | ---- | ----------- | ----- |
400
+ | `signature_request_create_embedded_request` | [**SignatureRequestCreateEmbeddedRequest**](SignatureRequestCreateEmbeddedRequest.md) | | |
401
+
402
+ ### Return type
403
+
404
+ [**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
405
+
406
+ ### Authorization
407
+
408
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
409
+
410
+ ### HTTP request headers
411
+
412
+ - **Content-Type**: application/json, multipart/form-data
413
+ - **Accept**: application/json
414
+
415
+
416
+ ## `signature_request_create_embedded_with_template`
417
+
418
+ > `<SignatureRequestGetResponse> signature_request_create_embedded_with_template(signature_request_create_embedded_with_template_request)`
419
+
420
+ Create Embedded Signature Request with Template
421
+
422
+ 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 Dropbox Sign.
423
+
424
+ ### Examples
425
+
426
+ ```ruby
427
+ require "dropbox-sign"
428
+
429
+ Dropbox::Sign.configure do |config|
430
+ # Configure HTTP basic authorization: api_key
431
+ config.username = "YOUR_API_KEY"
432
+
433
+ # or, configure Bearer (JWT) authorization: oauth2
434
+ # config.access_token = "YOUR_ACCESS_TOKEN"
435
+ end
436
+
437
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
438
+
439
+ signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
440
+ signer_1.role = "Client"
441
+ signer_1.email_address = "jack@example.com"
442
+ signer_1.name = "Jack"
443
+
444
+ signing_options = Dropbox::Sign::SubSigningOptions.new
445
+ signing_options.draw = true
446
+ signing_options.type = true
447
+ signing_options.upload = true
448
+ signing_options.phone = true
449
+ signing_options.default_type = "draw"
450
+
451
+ data = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new
452
+ data.client_id = "ec64a202072370a737edf4a0eb7f4437"
453
+ data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]
454
+ data.subject = "Purchase Order"
455
+ data.message = "Glad we could come to an agreement."
456
+ data.signers = [signer_1]
457
+ data.signing_options = signing_options
458
+ data.test_mode = true
459
+
460
+ begin
461
+ result = signature_request_api.signature_request_create_embedded_with_template(data)
462
+ p result
463
+ rescue Dropbox::Sign::ApiError => e
464
+ puts "Exception when calling Dropbox Sign API: #{e}"
465
+ end
466
+
467
+ ```
468
+
469
+ #### Using the `signature_request_create_embedded_with_template_with_http_info` variant
470
+
471
+ This returns an Array which contains the response data, status code and headers.
472
+
473
+ > `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_create_embedded_with_template_with_http_info(signature_request_create_embedded_with_template_request)`
474
+
475
+ ```ruby
476
+ begin
477
+ # Create Embedded Signature Request with Template
478
+ data, status_code, headers = api_instance.signature_request_create_embedded_with_template_with_http_info(signature_request_create_embedded_with_template_request)
479
+ p status_code # => 2xx
480
+ p headers # => { ... }
481
+ p data # => <SignatureRequestGetResponse>
482
+ rescue Dropbox::Sign::ApiError => e
483
+ puts "Error when calling SignatureRequestApi->signature_request_create_embedded_with_template_with_http_info: #{e}"
484
+ end
485
+ ```
486
+
487
+ ### Parameters
488
+
489
+ | Name | Type | Description | Notes |
490
+ | ---- | ---- | ----------- | ----- |
491
+ | `signature_request_create_embedded_with_template_request` | [**SignatureRequestCreateEmbeddedWithTemplateRequest**](SignatureRequestCreateEmbeddedWithTemplateRequest.md) | | |
492
+
493
+ ### Return type
494
+
495
+ [**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
496
+
497
+ ### Authorization
498
+
499
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
500
+
501
+ ### HTTP request headers
502
+
503
+ - **Content-Type**: application/json, multipart/form-data
504
+ - **Accept**: application/json
505
+
506
+
507
+ ## `signature_request_files`
508
+
509
+ > `File signature_request_files(signature_request_id, opts)`
510
+
511
+ Download Files
512
+
513
+ Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead.
514
+
515
+ ### Examples
516
+
517
+ ```ruby
518
+ require "dropbox-sign"
519
+
520
+ Dropbox::Sign.configure do |config|
521
+ # Configure HTTP basic authorization: api_key
522
+ config.username = "YOUR_API_KEY"
523
+
524
+ # or, configure Bearer (JWT) authorization: oauth2
525
+ # config.access_token = "YOUR_ACCESS_TOKEN"
526
+ end
527
+
528
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
529
+
530
+ signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
531
+
532
+ begin
533
+ file_bin = signature_request_api.signature_request_files(signature_request_id)
534
+ FileUtils.cp(file_bin.path, "path/to/file.pdf")
535
+ rescue Dropbox::Sign::ApiError => e
536
+ puts "Exception when calling Dropbox Sign API: #{e}"
537
+ end
538
+
539
+ ```
540
+
541
+ #### Using the `signature_request_files_with_http_info` variant
542
+
543
+ This returns an Array which contains the response data, status code and headers.
544
+
545
+ > `<Array(File, Integer, Hash)> signature_request_files_with_http_info(signature_request_id, opts)`
546
+
547
+ ```ruby
548
+ begin
549
+ # Download Files
550
+ data, status_code, headers = api_instance.signature_request_files_with_http_info(signature_request_id, opts)
551
+ p status_code # => 2xx
552
+ p headers # => { ... }
553
+ p data # => File
554
+ rescue Dropbox::Sign::ApiError => e
555
+ puts "Error when calling SignatureRequestApi->signature_request_files_with_http_info: #{e}"
556
+ end
557
+ ```
558
+
559
+ ### Parameters
560
+
561
+ | Name | Type | Description | Notes |
562
+ | ---- | ---- | ----------- | ----- |
563
+ | `signature_request_id` | **String** | The id of the SignatureRequest to retrieve. | |
564
+ | `file_type` | **String** | Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional][default to &#39;pdf&#39;] |
565
+
566
+ ### Return type
567
+
568
+ **File**
569
+
570
+ ### Authorization
571
+
572
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
573
+
574
+ ### HTTP request headers
575
+
576
+ - **Content-Type**: Not defined
577
+ - **Accept**: application/pdf, application/zip, application/json
578
+
579
+
580
+ ## `signature_request_files_as_data_uri`
581
+
582
+ > `<FileResponseDataUri> signature_request_files_as_data_uri(signature_request_id)`
583
+
584
+ Download Files as Data Uri
585
+
586
+ Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
587
+
588
+ ### Examples
589
+
590
+ ```ruby
591
+ require "dropbox-sign"
592
+
593
+ Dropbox::Sign.configure do |config|
594
+ # Configure HTTP basic authorization: api_key
595
+ config.username = "YOUR_API_KEY"
596
+
597
+ # or, configure Bearer (JWT) authorization: oauth2
598
+ # config.access_token = "YOUR_ACCESS_TOKEN"
599
+ end
600
+
601
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
602
+
603
+ signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
604
+
605
+ begin
606
+ result = signature_request_api.signature_request_files_as_data_uri(signature_request_id)
607
+ p result
608
+ rescue Dropbox::Sign::ApiError => e
609
+ puts "Exception when calling Dropbox Sign API: #{e}"
610
+ end
611
+
612
+ ```
613
+
614
+ #### Using the `signature_request_files_as_data_uri_with_http_info` variant
615
+
616
+ This returns an Array which contains the response data, status code and headers.
617
+
618
+ > `<Array(<FileResponseDataUri>, Integer, Hash)> signature_request_files_as_data_uri_with_http_info(signature_request_id)`
619
+
620
+ ```ruby
621
+ begin
622
+ # Download Files as Data Uri
623
+ data, status_code, headers = api_instance.signature_request_files_as_data_uri_with_http_info(signature_request_id)
624
+ p status_code # => 2xx
625
+ p headers # => { ... }
626
+ p data # => <FileResponseDataUri>
627
+ rescue Dropbox::Sign::ApiError => e
628
+ puts "Error when calling SignatureRequestApi->signature_request_files_as_data_uri_with_http_info: #{e}"
629
+ end
630
+ ```
631
+
632
+ ### Parameters
633
+
634
+ | Name | Type | Description | Notes |
635
+ | ---- | ---- | ----------- | ----- |
636
+ | `signature_request_id` | **String** | The id of the SignatureRequest to retrieve. | |
637
+
638
+ ### Return type
639
+
640
+ [**FileResponseDataUri**](FileResponseDataUri.md)
641
+
642
+ ### Authorization
643
+
644
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
645
+
646
+ ### HTTP request headers
647
+
648
+ - **Content-Type**: Not defined
649
+ - **Accept**: application/json
650
+
651
+
652
+ ## `signature_request_files_as_file_url`
653
+
654
+ > `<FileResponse> signature_request_files_as_file_url(signature_request_id)`
655
+
656
+ Download Files as File Url
657
+
658
+ Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
659
+
660
+ ### Examples
661
+
662
+ ```ruby
663
+ require "dropbox-sign"
664
+
665
+ Dropbox::Sign.configure do |config|
666
+ # Configure HTTP basic authorization: api_key
667
+ config.username = "YOUR_API_KEY"
668
+
669
+ # or, configure Bearer (JWT) authorization: oauth2
670
+ # config.access_token = "YOUR_ACCESS_TOKEN"
671
+ end
672
+
673
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
674
+
675
+ signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
676
+
677
+ begin
678
+ result = signature_request_api.signature_request_files_as_file_url(signature_request_id)
679
+ p result
680
+ rescue Dropbox::Sign::ApiError => e
681
+ puts "Exception when calling Dropbox Sign API: #{e}"
682
+ end
683
+
684
+ ```
685
+
686
+ #### Using the `signature_request_files_as_file_url_with_http_info` variant
687
+
688
+ This returns an Array which contains the response data, status code and headers.
689
+
690
+ > `<Array(<FileResponse>, Integer, Hash)> signature_request_files_as_file_url_with_http_info(signature_request_id)`
691
+
692
+ ```ruby
693
+ begin
694
+ # Download Files as File Url
695
+ data, status_code, headers = api_instance.signature_request_files_as_file_url_with_http_info(signature_request_id)
696
+ p status_code # => 2xx
697
+ p headers # => { ... }
698
+ p data # => <FileResponse>
699
+ rescue Dropbox::Sign::ApiError => e
700
+ puts "Error when calling SignatureRequestApi->signature_request_files_as_file_url_with_http_info: #{e}"
701
+ end
702
+ ```
703
+
704
+ ### Parameters
705
+
706
+ | Name | Type | Description | Notes |
707
+ | ---- | ---- | ----------- | ----- |
708
+ | `signature_request_id` | **String** | The id of the SignatureRequest to retrieve. | |
709
+
710
+ ### Return type
711
+
712
+ [**FileResponse**](FileResponse.md)
713
+
714
+ ### Authorization
715
+
716
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
717
+
718
+ ### HTTP request headers
719
+
720
+ - **Content-Type**: Not defined
721
+ - **Accept**: application/json
722
+
723
+
724
+ ## `signature_request_get`
725
+
726
+ > `<SignatureRequestGetResponse> signature_request_get(signature_request_id)`
727
+
728
+ Get Signature Request
729
+
730
+ Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
731
+
732
+ ### Examples
733
+
734
+ ```ruby
735
+ require "dropbox-sign"
736
+
737
+ Dropbox::Sign.configure do |config|
738
+ # Configure HTTP basic authorization: api_key
739
+ config.username = "YOUR_API_KEY"
740
+
741
+ # or, configure Bearer (JWT) authorization: oauth2
742
+ # config.access_token = "YOUR_ACCESS_TOKEN"
743
+ end
744
+
745
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
746
+
747
+ signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
748
+
749
+ begin
750
+ result = signature_request_api.signature_request_get(signature_request_id)
751
+ p result
752
+ rescue Dropbox::Sign::ApiError => e
753
+ puts "Exception when calling Dropbox Sign API: #{e}"
754
+ end
755
+
756
+ ```
757
+
758
+ #### Using the `signature_request_get_with_http_info` variant
759
+
760
+ This returns an Array which contains the response data, status code and headers.
761
+
762
+ > `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_get_with_http_info(signature_request_id)`
763
+
764
+ ```ruby
765
+ begin
766
+ # Get Signature Request
767
+ data, status_code, headers = api_instance.signature_request_get_with_http_info(signature_request_id)
768
+ p status_code # => 2xx
769
+ p headers # => { ... }
770
+ p data # => <SignatureRequestGetResponse>
771
+ rescue Dropbox::Sign::ApiError => e
772
+ puts "Error when calling SignatureRequestApi->signature_request_get_with_http_info: #{e}"
773
+ end
774
+ ```
775
+
776
+ ### Parameters
777
+
778
+ | Name | Type | Description | Notes |
779
+ | ---- | ---- | ----------- | ----- |
780
+ | `signature_request_id` | **String** | The id of the SignatureRequest to retrieve. | |
781
+
782
+ ### Return type
783
+
784
+ [**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
785
+
786
+ ### Authorization
787
+
788
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
789
+
790
+ ### HTTP request headers
791
+
792
+ - **Content-Type**: Not defined
793
+ - **Accept**: application/json
794
+
795
+
796
+ ## `signature_request_list`
797
+
798
+ > `<SignatureRequestListResponse> signature_request_list(opts)`
799
+
800
+ List Signature Requests
801
+
802
+ 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. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
803
+
804
+ ### Examples
805
+
806
+ ```ruby
807
+ require "dropbox-sign"
808
+
809
+ Dropbox::Sign.configure do |config|
810
+ # Configure HTTP basic authorization: api_key
811
+ config.username = "YOUR_API_KEY"
812
+
813
+ # or, configure Bearer (JWT) authorization: oauth2
814
+ # config.access_token = "YOUR_ACCESS_TOKEN"
815
+ end
816
+
817
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
818
+
819
+ account_id = null
820
+ page = 1
821
+
822
+ begin
823
+ result = signature_request_api.signature_request_list({account_id: account_id, page: page})
824
+ p result
825
+ rescue Dropbox::Sign::ApiError => e
826
+ puts "Exception when calling Dropbox Sign API: #{e}"
827
+ end
828
+
829
+ ```
830
+
831
+ #### Using the `signature_request_list_with_http_info` variant
832
+
833
+ This returns an Array which contains the response data, status code and headers.
834
+
835
+ > `<Array(<SignatureRequestListResponse>, Integer, Hash)> signature_request_list_with_http_info(opts)`
836
+
837
+ ```ruby
838
+ begin
839
+ # List Signature Requests
840
+ data, status_code, headers = api_instance.signature_request_list_with_http_info(opts)
841
+ p status_code # => 2xx
842
+ p headers # => { ... }
843
+ p data # => <SignatureRequestListResponse>
844
+ rescue Dropbox::Sign::ApiError => e
845
+ puts "Error when calling SignatureRequestApi->signature_request_list_with_http_info: #{e}"
846
+ end
847
+ ```
848
+
849
+ ### Parameters
850
+
851
+ | Name | Type | Description | Notes |
852
+ | ---- | ---- | ----------- | ----- |
853
+ | `account_id` | **String** | Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] |
854
+ | `page` | **Integer** | Which page number of the SignatureRequest List to return. Defaults to `1`. | [optional][default to 1] |
855
+ | `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] |
856
+ | `query` | **String** | String that includes search terms and/or fields to be used to filter the SignatureRequest objects. | [optional] |
857
+
858
+ ### Return type
859
+
860
+ [**SignatureRequestListResponse**](SignatureRequestListResponse.md)
861
+
862
+ ### Authorization
863
+
864
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
865
+
866
+ ### HTTP request headers
867
+
868
+ - **Content-Type**: Not defined
869
+ - **Accept**: application/json
870
+
871
+
872
+ ## `signature_request_release_hold`
873
+
874
+ > `<SignatureRequestGetResponse> signature_request_release_hold(signature_request_id)`
875
+
876
+ Release On-Hold Signature Request
877
+
878
+ 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.
879
+
880
+ ### Examples
881
+
882
+ ```ruby
883
+ require "dropbox-sign"
884
+
885
+ Dropbox::Sign.configure do |config|
886
+ # Configure HTTP basic authorization: api_key
887
+ config.username = "YOUR_API_KEY"
888
+
889
+ # or, configure Bearer (JWT) authorization: oauth2
890
+ # config.access_token = "YOUR_ACCESS_TOKEN"
891
+ end
892
+
893
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
894
+
895
+ signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
896
+
897
+ begin
898
+ result = signature_request_api.signature_request_release_hold(signature_request_id)
899
+ p result
900
+ rescue Dropbox::Sign::ApiError => e
901
+ puts "Exception when calling Dropbox Sign API: #{e}"
902
+ end
903
+
904
+ ```
905
+
906
+ #### Using the `signature_request_release_hold_with_http_info` variant
907
+
908
+ This returns an Array which contains the response data, status code and headers.
909
+
910
+ > `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_release_hold_with_http_info(signature_request_id)`
911
+
912
+ ```ruby
913
+ begin
914
+ # Release On-Hold Signature Request
915
+ data, status_code, headers = api_instance.signature_request_release_hold_with_http_info(signature_request_id)
916
+ p status_code # => 2xx
917
+ p headers # => { ... }
918
+ p data # => <SignatureRequestGetResponse>
919
+ rescue Dropbox::Sign::ApiError => e
920
+ puts "Error when calling SignatureRequestApi->signature_request_release_hold_with_http_info: #{e}"
921
+ end
922
+ ```
923
+
924
+ ### Parameters
925
+
926
+ | Name | Type | Description | Notes |
927
+ | ---- | ---- | ----------- | ----- |
928
+ | `signature_request_id` | **String** | The id of the SignatureRequest to release. | |
929
+
930
+ ### Return type
931
+
932
+ [**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
933
+
934
+ ### Authorization
935
+
936
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
937
+
938
+ ### HTTP request headers
939
+
940
+ - **Content-Type**: Not defined
941
+ - **Accept**: application/json
942
+
943
+
944
+ ## `signature_request_remind`
945
+
946
+ > `<SignatureRequestGetResponse> signature_request_remind(signature_request_id, signature_request_remind_request)`
947
+
948
+ Send Request Reminder
949
+
950
+ 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. **NOTE**: This action can **not** be used with embedded signature requests.
951
+
952
+ ### Examples
953
+
954
+ ```ruby
955
+ require "dropbox-sign"
956
+
957
+ Dropbox::Sign.configure do |config|
958
+ # Configure HTTP basic authorization: api_key
959
+ config.username = "YOUR_API_KEY"
960
+
961
+ # or, configure Bearer (JWT) authorization: oauth2
962
+ # config.access_token = "YOUR_ACCESS_TOKEN"
963
+ end
964
+
965
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
966
+
967
+ data = Dropbox::Sign::SignatureRequestRemindRequest.new
968
+ data.email_address = "john@example.com"
969
+
970
+ signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
971
+
972
+ begin
973
+ result = signature_request_api.signature_request_remind(signature_request_id, data)
974
+ p result
975
+ rescue Dropbox::Sign::ApiError => e
976
+ puts "Exception when calling Dropbox Sign API: #{e}"
977
+ end
978
+
979
+ ```
980
+
981
+ #### Using the `signature_request_remind_with_http_info` variant
982
+
983
+ This returns an Array which contains the response data, status code and headers.
984
+
985
+ > `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_remind_with_http_info(signature_request_id, signature_request_remind_request)`
986
+
987
+ ```ruby
988
+ begin
989
+ # Send Request Reminder
990
+ data, status_code, headers = api_instance.signature_request_remind_with_http_info(signature_request_id, signature_request_remind_request)
991
+ p status_code # => 2xx
992
+ p headers # => { ... }
993
+ p data # => <SignatureRequestGetResponse>
994
+ rescue Dropbox::Sign::ApiError => e
995
+ puts "Error when calling SignatureRequestApi->signature_request_remind_with_http_info: #{e}"
996
+ end
997
+ ```
998
+
999
+ ### Parameters
1000
+
1001
+ | Name | Type | Description | Notes |
1002
+ | ---- | ---- | ----------- | ----- |
1003
+ | `signature_request_id` | **String** | The id of the SignatureRequest to send a reminder for. | |
1004
+ | `signature_request_remind_request` | [**SignatureRequestRemindRequest**](SignatureRequestRemindRequest.md) | | |
1005
+
1006
+ ### Return type
1007
+
1008
+ [**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
1009
+
1010
+ ### Authorization
1011
+
1012
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
1013
+
1014
+ ### HTTP request headers
1015
+
1016
+ - **Content-Type**: application/json
1017
+ - **Accept**: application/json
1018
+
1019
+
1020
+ ## `signature_request_remove`
1021
+
1022
+ > `signature_request_remove(signature_request_id)`
1023
+
1024
+ Remove Signature Request Access
1025
+
1026
+ Removes your access to a completed signature request. This action is **not reversible**. 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). 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.
1027
+
1028
+ ### Examples
1029
+
1030
+ ```ruby
1031
+ require "dropbox-sign"
1032
+
1033
+ Dropbox::Sign.configure do |config|
1034
+ # Configure HTTP basic authorization: api_key
1035
+ config.username = "YOUR_API_KEY"
1036
+
1037
+ # or, configure Bearer (JWT) authorization: oauth2
1038
+ # config.access_token = "YOUR_ACCESS_TOKEN"
1039
+ end
1040
+
1041
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
1042
+
1043
+ signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
1044
+
1045
+ begin
1046
+ result = signature_request_api.signature_request_remove(signature_request_id)
1047
+ p result
1048
+ rescue Dropbox::Sign::ApiError => e
1049
+ puts "Exception when calling Dropbox Sign API: #{e}"
1050
+ end
1051
+
1052
+ ```
1053
+
1054
+ #### Using the `signature_request_remove_with_http_info` variant
1055
+
1056
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1057
+
1058
+ > `<Array(nil, Integer, Hash)> signature_request_remove_with_http_info(signature_request_id)`
1059
+
1060
+ ```ruby
1061
+ begin
1062
+ # Remove Signature Request Access
1063
+ data, status_code, headers = api_instance.signature_request_remove_with_http_info(signature_request_id)
1064
+ p status_code # => 2xx
1065
+ p headers # => { ... }
1066
+ p data # => nil
1067
+ rescue Dropbox::Sign::ApiError => e
1068
+ puts "Error when calling SignatureRequestApi->signature_request_remove_with_http_info: #{e}"
1069
+ end
1070
+ ```
1071
+
1072
+ ### Parameters
1073
+
1074
+ | Name | Type | Description | Notes |
1075
+ | ---- | ---- | ----------- | ----- |
1076
+ | `signature_request_id` | **String** | The id of the SignatureRequest to remove. | |
1077
+
1078
+ ### Return type
1079
+
1080
+ nil (empty response body)
1081
+
1082
+ ### Authorization
1083
+
1084
+ [api_key](../README.md#api_key)
1085
+
1086
+ ### HTTP request headers
1087
+
1088
+ - **Content-Type**: Not defined
1089
+ - **Accept**: application/json
1090
+
1091
+
1092
+ ## `signature_request_send`
1093
+
1094
+ > `<SignatureRequestGetResponse> signature_request_send(signature_request_send_request)`
1095
+
1096
+ Send Signature Request
1097
+
1098
+ 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.
1099
+
1100
+ ### Examples
1101
+
1102
+ ```ruby
1103
+ require "dropbox-sign"
1104
+
1105
+ Dropbox::Sign.configure do |config|
1106
+ # Configure HTTP basic authorization: api_key
1107
+ config.username = "YOUR_API_KEY"
1108
+
1109
+ # or, configure Bearer (JWT) authorization: oauth2
1110
+ # config.access_token = "YOUR_ACCESS_TOKEN"
1111
+ end
1112
+
1113
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
1114
+
1115
+ signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new
1116
+ signer_1.email_address = "jack@example.com"
1117
+ signer_1.name = "Jack"
1118
+ signer_1.order = 0
1119
+
1120
+ signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new
1121
+ signer_2.email_address = "jill@example.com"
1122
+ signer_2.name = "Jill"
1123
+ signer_2.order = 1
1124
+
1125
+ signing_options = Dropbox::Sign::SubSigningOptions.new
1126
+ signing_options.draw = true
1127
+ signing_options.type = true
1128
+ signing_options.upload = true
1129
+ signing_options.phone = true
1130
+ signing_options.default_type = "draw"
1131
+
1132
+ field_options = Dropbox::Sign::SubFieldOptions.new
1133
+ field_options.date_format = "DD - MM - YYYY"
1134
+
1135
+ data = Dropbox::Sign::SignatureRequestSendRequest.new
1136
+ data.title = "NDA with Acme Co."
1137
+ data.subject = "The NDA we talked about"
1138
+ data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
1139
+ data.signers = [signer_1, signer_2]
1140
+ data.cc_email_addresses = [
1141
+ "lawyer@dropboxsign.com",
1142
+ "lawyer@dropboxsign.com",
1143
+ ]
1144
+ data.files = [File.new("example_signature_request.pdf", "r")]
1145
+ data.metadata = {
1146
+ custom_id: 1234,
1147
+ custom_text: "NDA #9",
1148
+ }
1149
+ data.signing_options = signing_options
1150
+ data.field_options = field_options
1151
+ data.test_mode = true
1152
+
1153
+ begin
1154
+ result = signature_request_api.signature_request_send(data)
1155
+ p result
1156
+ rescue Dropbox::Sign::ApiError => e
1157
+ puts "Exception when calling Dropbox Sign API: #{e}"
1158
+ end
1159
+
1160
+ ```
1161
+
1162
+ #### Using the `signature_request_send_with_http_info` variant
1163
+
1164
+ This returns an Array which contains the response data, status code and headers.
1165
+
1166
+ > `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_send_with_http_info(signature_request_send_request)`
1167
+
1168
+ ```ruby
1169
+ begin
1170
+ # Send Signature Request
1171
+ data, status_code, headers = api_instance.signature_request_send_with_http_info(signature_request_send_request)
1172
+ p status_code # => 2xx
1173
+ p headers # => { ... }
1174
+ p data # => <SignatureRequestGetResponse>
1175
+ rescue Dropbox::Sign::ApiError => e
1176
+ puts "Error when calling SignatureRequestApi->signature_request_send_with_http_info: #{e}"
1177
+ end
1178
+ ```
1179
+
1180
+ ### Parameters
1181
+
1182
+ | Name | Type | Description | Notes |
1183
+ | ---- | ---- | ----------- | ----- |
1184
+ | `signature_request_send_request` | [**SignatureRequestSendRequest**](SignatureRequestSendRequest.md) | | |
1185
+
1186
+ ### Return type
1187
+
1188
+ [**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
1189
+
1190
+ ### Authorization
1191
+
1192
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
1193
+
1194
+ ### HTTP request headers
1195
+
1196
+ - **Content-Type**: application/json, multipart/form-data
1197
+ - **Accept**: application/json
1198
+
1199
+
1200
+ ## `signature_request_send_with_template`
1201
+
1202
+ > `<SignatureRequestGetResponse> signature_request_send_with_template(signature_request_send_with_template_request)`
1203
+
1204
+ Send with Template
1205
+
1206
+ Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.
1207
+
1208
+ ### Examples
1209
+
1210
+ ```ruby
1211
+ require "dropbox-sign"
1212
+
1213
+ Dropbox::Sign.configure do |config|
1214
+ # Configure HTTP basic authorization: api_key
1215
+ config.username = "YOUR_API_KEY"
1216
+
1217
+ # or, configure Bearer (JWT) authorization: oauth2
1218
+ # config.access_token = "YOUR_ACCESS_TOKEN"
1219
+ end
1220
+
1221
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
1222
+
1223
+ signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
1224
+ signer_1.role = "Client"
1225
+ signer_1.email_address = "george@example.com"
1226
+ signer_1.name = "George"
1227
+
1228
+ cc_1 = Dropbox::Sign::SubCC.new
1229
+ cc_1.role = "Accounting"
1230
+ cc_1.email_address = "accounting@example.com"
1231
+
1232
+ custom_field_1 = Dropbox::Sign::SubCustomField.new
1233
+ custom_field_1.name = "Cost"
1234
+ custom_field_1.value = "$20,000"
1235
+ custom_field_1.editor = "Client"
1236
+ custom_field_1.required = true
1237
+
1238
+ signing_options = Dropbox::Sign::SubSigningOptions.new
1239
+ signing_options.draw = true
1240
+ signing_options.type = true
1241
+ signing_options.upload = true
1242
+ signing_options.phone = false
1243
+ signing_options.default_type = "draw"
1244
+
1245
+ data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new
1246
+ data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]
1247
+ data.subject = "Purchase Order"
1248
+ data.message = "Glad we could come to an agreement."
1249
+ data.signers = [signer_1]
1250
+ data.ccs = [cc_1]
1251
+ data.custom_fields = [custom_field_1]
1252
+ data.signing_options = signing_options
1253
+ data.test_mode = true
1254
+
1255
+ begin
1256
+ result = signature_request_api.signature_request_send_with_template(data)
1257
+ p result
1258
+ rescue Dropbox::Sign::ApiError => e
1259
+ puts "Exception when calling Dropbox Sign API: #{e}"
1260
+ end
1261
+
1262
+ ```
1263
+
1264
+ #### Using the `signature_request_send_with_template_with_http_info` variant
1265
+
1266
+ This returns an Array which contains the response data, status code and headers.
1267
+
1268
+ > `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_send_with_template_with_http_info(signature_request_send_with_template_request)`
1269
+
1270
+ ```ruby
1271
+ begin
1272
+ # Send with Template
1273
+ data, status_code, headers = api_instance.signature_request_send_with_template_with_http_info(signature_request_send_with_template_request)
1274
+ p status_code # => 2xx
1275
+ p headers # => { ... }
1276
+ p data # => <SignatureRequestGetResponse>
1277
+ rescue Dropbox::Sign::ApiError => e
1278
+ puts "Error when calling SignatureRequestApi->signature_request_send_with_template_with_http_info: #{e}"
1279
+ end
1280
+ ```
1281
+
1282
+ ### Parameters
1283
+
1284
+ | Name | Type | Description | Notes |
1285
+ | ---- | ---- | ----------- | ----- |
1286
+ | `signature_request_send_with_template_request` | [**SignatureRequestSendWithTemplateRequest**](SignatureRequestSendWithTemplateRequest.md) | | |
1287
+
1288
+ ### Return type
1289
+
1290
+ [**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
1291
+
1292
+ ### Authorization
1293
+
1294
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
1295
+
1296
+ ### HTTP request headers
1297
+
1298
+ - **Content-Type**: application/json, multipart/form-data
1299
+ - **Accept**: application/json
1300
+
1301
+
1302
+ ## `signature_request_update`
1303
+
1304
+ > `<SignatureRequestGetResponse> signature_request_update(signature_request_id, signature_request_update_request)`
1305
+
1306
+ Update Signature Request
1307
+
1308
+ 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. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
1309
+
1310
+ ### Examples
1311
+
1312
+ ```ruby
1313
+ require "dropbox-sign"
1314
+
1315
+ Dropbox::Sign.configure do |config|
1316
+ # Configure HTTP basic authorization: api_key
1317
+ config.username = "YOUR_API_KEY"
1318
+
1319
+ # or, configure Bearer (JWT) authorization: oauth2
1320
+ # config.access_token = "YOUR_ACCESS_TOKEN"
1321
+ end
1322
+
1323
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
1324
+
1325
+ data = Dropbox::Sign::SignatureRequestUpdateRequest.new
1326
+ data.email_address = "john@example.com"
1327
+ data.signature_id = "78caf2a1d01cd39cea2bc1cbb340dac3"
1328
+
1329
+ signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
1330
+
1331
+ begin
1332
+ result = signature_request_api.signature_request_update(signature_request_id, data)
1333
+ p result
1334
+ rescue Dropbox::Sign::ApiError => e
1335
+ puts "Exception when calling Dropbox Sign API: #{e}"
1336
+ end
1337
+
1338
+ ```
1339
+
1340
+ #### Using the `signature_request_update_with_http_info` variant
1341
+
1342
+ This returns an Array which contains the response data, status code and headers.
1343
+
1344
+ > `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_update_with_http_info(signature_request_id, signature_request_update_request)`
1345
+
1346
+ ```ruby
1347
+ begin
1348
+ # Update Signature Request
1349
+ data, status_code, headers = api_instance.signature_request_update_with_http_info(signature_request_id, signature_request_update_request)
1350
+ p status_code # => 2xx
1351
+ p headers # => { ... }
1352
+ p data # => <SignatureRequestGetResponse>
1353
+ rescue Dropbox::Sign::ApiError => e
1354
+ puts "Error when calling SignatureRequestApi->signature_request_update_with_http_info: #{e}"
1355
+ end
1356
+ ```
1357
+
1358
+ ### Parameters
1359
+
1360
+ | Name | Type | Description | Notes |
1361
+ | ---- | ---- | ----------- | ----- |
1362
+ | `signature_request_id` | **String** | The id of the SignatureRequest to update. | |
1363
+ | `signature_request_update_request` | [**SignatureRequestUpdateRequest**](SignatureRequestUpdateRequest.md) | | |
1364
+
1365
+ ### Return type
1366
+
1367
+ [**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
1368
+
1369
+ ### Authorization
1370
+
1371
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
1372
+
1373
+ ### HTTP request headers
1374
+
1375
+ - **Content-Type**: application/json
1376
+ - **Accept**: application/json
1377
+