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,1620 @@
1
+ =begin
2
+ #Dropbox Sign API
3
+
4
+ #Dropbox Sign v3 API
5
+
6
+ The version of the OpenAPI document: 3.0.0
7
+ Contact: apisupport@hellosign.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Dropbox
16
+ end
17
+
18
+ module Dropbox::Sign
19
+ class SignatureRequestApi
20
+ attr_accessor :api_client
21
+
22
+ def initialize(api_client = ApiClient.default)
23
+ @api_client = api_client
24
+ end
25
+ # Embedded Bulk Send with Template
26
+ # 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.
27
+ # @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
28
+ # @param [Hash] opts the optional parameters
29
+ # @return [BulkSendJobSendResponse]
30
+ def signature_request_bulk_create_embedded_with_template(signature_request_bulk_create_embedded_with_template_request, opts = {})
31
+ data, _status_code, _headers = signature_request_bulk_create_embedded_with_template_with_http_info(signature_request_bulk_create_embedded_with_template_request, opts)
32
+ data
33
+ end
34
+
35
+ # Embedded Bulk Send with Template
36
+ # 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.
37
+ # @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
40
+ def signature_request_bulk_create_embedded_with_template_with_http_info(signature_request_bulk_create_embedded_with_template_request, opts = {})
41
+ if @api_client.config.debugging
42
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_bulk_create_embedded_with_template ...'
43
+ end
44
+ # verify the required parameter 'signature_request_bulk_create_embedded_with_template_request' is set
45
+ if @api_client.config.client_side_validation && signature_request_bulk_create_embedded_with_template_request.nil?
46
+ fail ArgumentError, "Missing the required parameter 'signature_request_bulk_create_embedded_with_template_request' when calling SignatureRequestApi.signature_request_bulk_create_embedded_with_template"
47
+ end
48
+ # resource path
49
+ local_var_path = '/signature_request/bulk_create_embedded_with_template'
50
+
51
+ # query parameters
52
+ query_params = opts[:query_params] || {}
53
+
54
+ # header parameters
55
+ header_params = opts[:header_params] || {}
56
+ # HTTP header 'Accept' (if needed)
57
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
58
+ # HTTP header 'Content-Type'
59
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
60
+ if !content_type.nil?
61
+ header_params['Content-Type'] = content_type
62
+ end
63
+
64
+ post_body = {}
65
+ form_params = opts[:form_params] || {}
66
+ result = @api_client.generate_form_data(
67
+ signature_request_bulk_create_embedded_with_template_request,
68
+ Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.openapi_types
69
+ )
70
+
71
+ # form parameters
72
+ if result[:has_file]
73
+ form_params = opts[:form_params] || result[:params]
74
+ header_params['Content-Type'] = 'multipart/form-data'
75
+ else
76
+ # http body (model)
77
+ post_body = opts[:debug_body] || result[:params]
78
+ end
79
+
80
+ # return_type
81
+ return_type = opts[:debug_return_type] || 'BulkSendJobSendResponse'
82
+
83
+ # auth_names
84
+ auth_names = opts[:debug_auth_names] || ['api_key']
85
+
86
+ new_options = opts.merge(
87
+ :operation => :"SignatureRequestApi.signature_request_bulk_create_embedded_with_template",
88
+ :header_params => header_params,
89
+ :query_params => query_params,
90
+ :form_params => form_params,
91
+ :body => post_body,
92
+ :auth_names => auth_names,
93
+ :return_type => return_type
94
+ )
95
+
96
+ begin
97
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
98
+ rescue Dropbox::Sign::ApiError => e
99
+ if e.code === 200
100
+ body = @api_client.convert_to_type(
101
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
102
+ "Dropbox::Sign::BulkSendJobSendResponse"
103
+ )
104
+
105
+ fail ApiError.new(:code => e.code,
106
+ :response_headers => e.response_headers,
107
+ :response_body => body),
108
+ e.message
109
+ end
110
+
111
+ range_code = "4XX".split('').first
112
+ range_code_left = "#{range_code}00".to_i
113
+ range_code_right = "#{range_code}99".to_i
114
+ if e.code >= range_code_left && e.code <= range_code_right
115
+ body = @api_client.convert_to_type(
116
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
117
+ "Dropbox::Sign::ErrorResponse"
118
+ )
119
+
120
+ fail ApiError.new(:code => e.code,
121
+ :response_headers => e.response_headers,
122
+ :response_body => body),
123
+ e.message
124
+ end
125
+
126
+ end
127
+
128
+ if @api_client.config.debugging
129
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_bulk_create_embedded_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
130
+ end
131
+ return data, status_code, headers
132
+ end
133
+
134
+ # Bulk Send with Template
135
+ # 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.
136
+ # @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
137
+ # @param [Hash] opts the optional parameters
138
+ # @return [BulkSendJobSendResponse]
139
+ def signature_request_bulk_send_with_template(signature_request_bulk_send_with_template_request, opts = {})
140
+ data, _status_code, _headers = signature_request_bulk_send_with_template_with_http_info(signature_request_bulk_send_with_template_request, opts)
141
+ data
142
+ end
143
+
144
+ # Bulk Send with Template
145
+ # Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the &#x60;template_ids&#x60; parameter. **NOTE**: Only available for Standard plan and higher.
146
+ # @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
147
+ # @param [Hash] opts the optional parameters
148
+ # @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
149
+ def signature_request_bulk_send_with_template_with_http_info(signature_request_bulk_send_with_template_request, opts = {})
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_bulk_send_with_template ...'
152
+ end
153
+ # verify the required parameter 'signature_request_bulk_send_with_template_request' is set
154
+ if @api_client.config.client_side_validation && signature_request_bulk_send_with_template_request.nil?
155
+ fail ArgumentError, "Missing the required parameter 'signature_request_bulk_send_with_template_request' when calling SignatureRequestApi.signature_request_bulk_send_with_template"
156
+ end
157
+ # resource path
158
+ local_var_path = '/signature_request/bulk_send_with_template'
159
+
160
+ # query parameters
161
+ query_params = opts[:query_params] || {}
162
+
163
+ # header parameters
164
+ header_params = opts[:header_params] || {}
165
+ # HTTP header 'Accept' (if needed)
166
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
167
+ # HTTP header 'Content-Type'
168
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
169
+ if !content_type.nil?
170
+ header_params['Content-Type'] = content_type
171
+ end
172
+
173
+ post_body = {}
174
+ form_params = opts[:form_params] || {}
175
+ result = @api_client.generate_form_data(
176
+ signature_request_bulk_send_with_template_request,
177
+ Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.openapi_types
178
+ )
179
+
180
+ # form parameters
181
+ if result[:has_file]
182
+ form_params = opts[:form_params] || result[:params]
183
+ header_params['Content-Type'] = 'multipart/form-data'
184
+ else
185
+ # http body (model)
186
+ post_body = opts[:debug_body] || result[:params]
187
+ end
188
+
189
+ # return_type
190
+ return_type = opts[:debug_return_type] || 'BulkSendJobSendResponse'
191
+
192
+ # auth_names
193
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
194
+
195
+ new_options = opts.merge(
196
+ :operation => :"SignatureRequestApi.signature_request_bulk_send_with_template",
197
+ :header_params => header_params,
198
+ :query_params => query_params,
199
+ :form_params => form_params,
200
+ :body => post_body,
201
+ :auth_names => auth_names,
202
+ :return_type => return_type
203
+ )
204
+
205
+ begin
206
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
207
+ rescue Dropbox::Sign::ApiError => e
208
+ if e.code === 200
209
+ body = @api_client.convert_to_type(
210
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
211
+ "Dropbox::Sign::BulkSendJobSendResponse"
212
+ )
213
+
214
+ fail ApiError.new(:code => e.code,
215
+ :response_headers => e.response_headers,
216
+ :response_body => body),
217
+ e.message
218
+ end
219
+
220
+ range_code = "4XX".split('').first
221
+ range_code_left = "#{range_code}00".to_i
222
+ range_code_right = "#{range_code}99".to_i
223
+ if e.code >= range_code_left && e.code <= range_code_right
224
+ body = @api_client.convert_to_type(
225
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
226
+ "Dropbox::Sign::ErrorResponse"
227
+ )
228
+
229
+ fail ApiError.new(:code => e.code,
230
+ :response_headers => e.response_headers,
231
+ :response_body => body),
232
+ e.message
233
+ end
234
+
235
+ end
236
+
237
+ if @api_client.config.debugging
238
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_bulk_send_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
239
+ end
240
+ return data, status_code, headers
241
+ end
242
+
243
+ # Cancel Incomplete Signature Request
244
+ # 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]`.
245
+ # @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
246
+ # @param [Hash] opts the optional parameters
247
+ # @return [nil]
248
+ def signature_request_cancel(signature_request_id, opts = {})
249
+ signature_request_cancel_with_http_info(signature_request_id, opts)
250
+ nil
251
+ end
252
+
253
+ # Cancel Incomplete Signature Request
254
+ # 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 &#x60;signature_request_canceled&#x60; event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the &#x60;signature_request_canceled&#x60; 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: &#x60;POST /signature_request/remove/[:signature_request_id]&#x60;.
255
+ # @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
256
+ # @param [Hash] opts the optional parameters
257
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
258
+ def signature_request_cancel_with_http_info(signature_request_id, opts = {})
259
+ if @api_client.config.debugging
260
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_cancel ...'
261
+ end
262
+ # verify the required parameter 'signature_request_id' is set
263
+ if @api_client.config.client_side_validation && signature_request_id.nil?
264
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_cancel"
265
+ end
266
+ # resource path
267
+ local_var_path = '/signature_request/cancel/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
268
+
269
+ # query parameters
270
+ query_params = opts[:query_params] || {}
271
+
272
+ # header parameters
273
+ header_params = opts[:header_params] || {}
274
+ # HTTP header 'Accept' (if needed)
275
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
276
+
277
+ post_body = {}
278
+ form_params = opts[:form_params] || {}
279
+
280
+ # http body (model)
281
+ post_body = opts[:debug_body]
282
+
283
+ # return_type
284
+ return_type = opts[:debug_return_type]
285
+
286
+ # auth_names
287
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
288
+
289
+ new_options = opts.merge(
290
+ :operation => :"SignatureRequestApi.signature_request_cancel",
291
+ :header_params => header_params,
292
+ :query_params => query_params,
293
+ :form_params => form_params,
294
+ :body => post_body,
295
+ :auth_names => auth_names,
296
+ :return_type => return_type
297
+ )
298
+
299
+ begin
300
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
301
+ rescue Dropbox::Sign::ApiError => e
302
+ end
303
+
304
+ if @api_client.config.debugging
305
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
306
+ end
307
+ return data, status_code, headers
308
+ end
309
+
310
+ # Create Embedded Signature Request
311
+ # 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.
312
+ # @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
313
+ # @param [Hash] opts the optional parameters
314
+ # @return [SignatureRequestGetResponse]
315
+ def signature_request_create_embedded(signature_request_create_embedded_request, opts = {})
316
+ data, _status_code, _headers = signature_request_create_embedded_with_http_info(signature_request_create_embedded_request, opts)
317
+ data
318
+ end
319
+
320
+ # Create Embedded Signature Request
321
+ # 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. &lt;u&gt;Note&lt;/u&gt; that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
322
+ # @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
323
+ # @param [Hash] opts the optional parameters
324
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
325
+ def signature_request_create_embedded_with_http_info(signature_request_create_embedded_request, opts = {})
326
+ if @api_client.config.debugging
327
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_create_embedded ...'
328
+ end
329
+ # verify the required parameter 'signature_request_create_embedded_request' is set
330
+ if @api_client.config.client_side_validation && signature_request_create_embedded_request.nil?
331
+ fail ArgumentError, "Missing the required parameter 'signature_request_create_embedded_request' when calling SignatureRequestApi.signature_request_create_embedded"
332
+ end
333
+ # resource path
334
+ local_var_path = '/signature_request/create_embedded'
335
+
336
+ # query parameters
337
+ query_params = opts[:query_params] || {}
338
+
339
+ # header parameters
340
+ header_params = opts[:header_params] || {}
341
+ # HTTP header 'Accept' (if needed)
342
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
343
+ # HTTP header 'Content-Type'
344
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
345
+ if !content_type.nil?
346
+ header_params['Content-Type'] = content_type
347
+ end
348
+
349
+ post_body = {}
350
+ form_params = opts[:form_params] || {}
351
+ result = @api_client.generate_form_data(
352
+ signature_request_create_embedded_request,
353
+ Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.openapi_types
354
+ )
355
+
356
+ # form parameters
357
+ if result[:has_file]
358
+ form_params = opts[:form_params] || result[:params]
359
+ header_params['Content-Type'] = 'multipart/form-data'
360
+ else
361
+ # http body (model)
362
+ post_body = opts[:debug_body] || result[:params]
363
+ end
364
+
365
+ # return_type
366
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
367
+
368
+ # auth_names
369
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
370
+
371
+ new_options = opts.merge(
372
+ :operation => :"SignatureRequestApi.signature_request_create_embedded",
373
+ :header_params => header_params,
374
+ :query_params => query_params,
375
+ :form_params => form_params,
376
+ :body => post_body,
377
+ :auth_names => auth_names,
378
+ :return_type => return_type
379
+ )
380
+
381
+ begin
382
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
383
+ rescue Dropbox::Sign::ApiError => e
384
+ if e.code === 200
385
+ body = @api_client.convert_to_type(
386
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
387
+ "Dropbox::Sign::SignatureRequestGetResponse"
388
+ )
389
+
390
+ fail ApiError.new(:code => e.code,
391
+ :response_headers => e.response_headers,
392
+ :response_body => body),
393
+ e.message
394
+ end
395
+
396
+ range_code = "4XX".split('').first
397
+ range_code_left = "#{range_code}00".to_i
398
+ range_code_right = "#{range_code}99".to_i
399
+ if e.code >= range_code_left && e.code <= range_code_right
400
+ body = @api_client.convert_to_type(
401
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
402
+ "Dropbox::Sign::ErrorResponse"
403
+ )
404
+
405
+ fail ApiError.new(:code => e.code,
406
+ :response_headers => e.response_headers,
407
+ :response_body => body),
408
+ e.message
409
+ end
410
+
411
+ end
412
+
413
+ if @api_client.config.debugging
414
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_create_embedded\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
415
+ end
416
+ return data, status_code, headers
417
+ end
418
+
419
+ # Create Embedded Signature Request with Template
420
+ # 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.
421
+ # @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
422
+ # @param [Hash] opts the optional parameters
423
+ # @return [SignatureRequestGetResponse]
424
+ def signature_request_create_embedded_with_template(signature_request_create_embedded_with_template_request, opts = {})
425
+ data, _status_code, _headers = signature_request_create_embedded_with_template_with_http_info(signature_request_create_embedded_with_template_request, opts)
426
+ data
427
+ end
428
+
429
+ # Create Embedded Signature Request with Template
430
+ # Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. &lt;u&gt;Note&lt;/u&gt; that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
431
+ # @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
432
+ # @param [Hash] opts the optional parameters
433
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
434
+ def signature_request_create_embedded_with_template_with_http_info(signature_request_create_embedded_with_template_request, opts = {})
435
+ if @api_client.config.debugging
436
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_create_embedded_with_template ...'
437
+ end
438
+ # verify the required parameter 'signature_request_create_embedded_with_template_request' is set
439
+ if @api_client.config.client_side_validation && signature_request_create_embedded_with_template_request.nil?
440
+ fail ArgumentError, "Missing the required parameter 'signature_request_create_embedded_with_template_request' when calling SignatureRequestApi.signature_request_create_embedded_with_template"
441
+ end
442
+ # resource path
443
+ local_var_path = '/signature_request/create_embedded_with_template'
444
+
445
+ # query parameters
446
+ query_params = opts[:query_params] || {}
447
+
448
+ # header parameters
449
+ header_params = opts[:header_params] || {}
450
+ # HTTP header 'Accept' (if needed)
451
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
452
+ # HTTP header 'Content-Type'
453
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
454
+ if !content_type.nil?
455
+ header_params['Content-Type'] = content_type
456
+ end
457
+
458
+ post_body = {}
459
+ form_params = opts[:form_params] || {}
460
+ result = @api_client.generate_form_data(
461
+ signature_request_create_embedded_with_template_request,
462
+ Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.openapi_types
463
+ )
464
+
465
+ # form parameters
466
+ if result[:has_file]
467
+ form_params = opts[:form_params] || result[:params]
468
+ header_params['Content-Type'] = 'multipart/form-data'
469
+ else
470
+ # http body (model)
471
+ post_body = opts[:debug_body] || result[:params]
472
+ end
473
+
474
+ # return_type
475
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
476
+
477
+ # auth_names
478
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
479
+
480
+ new_options = opts.merge(
481
+ :operation => :"SignatureRequestApi.signature_request_create_embedded_with_template",
482
+ :header_params => header_params,
483
+ :query_params => query_params,
484
+ :form_params => form_params,
485
+ :body => post_body,
486
+ :auth_names => auth_names,
487
+ :return_type => return_type
488
+ )
489
+
490
+ begin
491
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
492
+ rescue Dropbox::Sign::ApiError => e
493
+ if e.code === 200
494
+ body = @api_client.convert_to_type(
495
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
496
+ "Dropbox::Sign::SignatureRequestGetResponse"
497
+ )
498
+
499
+ fail ApiError.new(:code => e.code,
500
+ :response_headers => e.response_headers,
501
+ :response_body => body),
502
+ e.message
503
+ end
504
+
505
+ range_code = "4XX".split('').first
506
+ range_code_left = "#{range_code}00".to_i
507
+ range_code_right = "#{range_code}99".to_i
508
+ if e.code >= range_code_left && e.code <= range_code_right
509
+ body = @api_client.convert_to_type(
510
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
511
+ "Dropbox::Sign::ErrorResponse"
512
+ )
513
+
514
+ fail ApiError.new(:code => e.code,
515
+ :response_headers => e.response_headers,
516
+ :response_body => body),
517
+ e.message
518
+ end
519
+
520
+ end
521
+
522
+ if @api_client.config.debugging
523
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_create_embedded_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
524
+ end
525
+ return data, status_code, headers
526
+ end
527
+
528
+ # Download Files
529
+ # 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.
530
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
531
+ # @param [Hash] opts the optional parameters
532
+ # @option opts [String] :file_type Set to &#x60;pdf&#x60; for a single merged document or &#x60;zip&#x60; for a collection of individual documents. (default to 'pdf')
533
+ # @return [File]
534
+ def signature_request_files(signature_request_id, opts = {})
535
+ data, _status_code, _headers = signature_request_files_with_http_info(signature_request_id, opts)
536
+ data
537
+ end
538
+
539
+ # Download Files
540
+ # Obtain a copy of the current documents specified by the &#x60;signature_request_id&#x60; parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead.
541
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
542
+ # @param [Hash] opts the optional parameters
543
+ # @option opts [String] :file_type Set to &#x60;pdf&#x60; for a single merged document or &#x60;zip&#x60; for a collection of individual documents.
544
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
545
+ def signature_request_files_with_http_info(signature_request_id, opts = {})
546
+ if @api_client.config.debugging
547
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_files ...'
548
+ end
549
+ # verify the required parameter 'signature_request_id' is set
550
+ if @api_client.config.client_side_validation && signature_request_id.nil?
551
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_files"
552
+ end
553
+ allowable_values = ["pdf", "zip"]
554
+ if @api_client.config.client_side_validation && opts[:'file_type'] && !allowable_values.include?(opts[:'file_type'])
555
+ fail ArgumentError, "invalid value for \"file_type\", must be one of #{allowable_values}"
556
+ end
557
+ # resource path
558
+ local_var_path = '/signature_request/files/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
559
+
560
+ # query parameters
561
+ query_params = opts[:query_params] || {}
562
+ query_params[:'file_type'] = opts[:'file_type'] if !opts[:'file_type'].nil?
563
+
564
+ # header parameters
565
+ header_params = opts[:header_params] || {}
566
+ # HTTP header 'Accept' (if needed)
567
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/zip', 'application/json'])
568
+
569
+ post_body = {}
570
+ form_params = opts[:form_params] || {}
571
+
572
+ # http body (model)
573
+ post_body = opts[:debug_body]
574
+
575
+ # return_type
576
+ return_type = opts[:debug_return_type] || 'File'
577
+
578
+ # auth_names
579
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
580
+
581
+ new_options = opts.merge(
582
+ :operation => :"SignatureRequestApi.signature_request_files",
583
+ :header_params => header_params,
584
+ :query_params => query_params,
585
+ :form_params => form_params,
586
+ :body => post_body,
587
+ :auth_names => auth_names,
588
+ :return_type => return_type
589
+ )
590
+
591
+ begin
592
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
593
+ rescue Dropbox::Sign::ApiError => e
594
+ if e.code === 200
595
+ body = @api_client.convert_to_type(
596
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
597
+ "Dropbox::Sign::File"
598
+ )
599
+
600
+ fail ApiError.new(:code => e.code,
601
+ :response_headers => e.response_headers,
602
+ :response_body => body),
603
+ e.message
604
+ end
605
+
606
+ range_code = "4XX".split('').first
607
+ range_code_left = "#{range_code}00".to_i
608
+ range_code_right = "#{range_code}99".to_i
609
+ if e.code >= range_code_left && e.code <= range_code_right
610
+ body = @api_client.convert_to_type(
611
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
612
+ "Dropbox::Sign::ErrorResponse"
613
+ )
614
+
615
+ fail ApiError.new(:code => e.code,
616
+ :response_headers => e.response_headers,
617
+ :response_body => body),
618
+ e.message
619
+ end
620
+
621
+ end
622
+
623
+ if @api_client.config.debugging
624
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
625
+ end
626
+ return data, status_code, headers
627
+ end
628
+
629
+ # Download Files as Data Uri
630
+ # 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.
631
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
632
+ # @param [Hash] opts the optional parameters
633
+ # @return [FileResponseDataUri]
634
+ def signature_request_files_as_data_uri(signature_request_id, opts = {})
635
+ data, _status_code, _headers = signature_request_files_as_data_uri_with_http_info(signature_request_id, opts)
636
+ data
637
+ end
638
+
639
+ # Download Files as Data Uri
640
+ # Obtain a copy of the current documents specified by the &#x60;signature_request_id&#x60; parameter. Returns a JSON object with a &#x60;data_uri&#x60; representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead.
641
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
642
+ # @param [Hash] opts the optional parameters
643
+ # @return [Array<(FileResponseDataUri, Integer, Hash)>] FileResponseDataUri data, response status code and response headers
644
+ def signature_request_files_as_data_uri_with_http_info(signature_request_id, opts = {})
645
+ if @api_client.config.debugging
646
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_files_as_data_uri ...'
647
+ end
648
+ # verify the required parameter 'signature_request_id' is set
649
+ if @api_client.config.client_side_validation && signature_request_id.nil?
650
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_files_as_data_uri"
651
+ end
652
+ # resource path
653
+ local_var_path = '/signature_request/files_as_data_uri/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
654
+
655
+ # query parameters
656
+ query_params = opts[:query_params] || {}
657
+
658
+ # header parameters
659
+ header_params = opts[:header_params] || {}
660
+ # HTTP header 'Accept' (if needed)
661
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
662
+
663
+ post_body = {}
664
+ form_params = opts[:form_params] || {}
665
+
666
+ # http body (model)
667
+ post_body = opts[:debug_body]
668
+
669
+ # return_type
670
+ return_type = opts[:debug_return_type] || 'FileResponseDataUri'
671
+
672
+ # auth_names
673
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
674
+
675
+ new_options = opts.merge(
676
+ :operation => :"SignatureRequestApi.signature_request_files_as_data_uri",
677
+ :header_params => header_params,
678
+ :query_params => query_params,
679
+ :form_params => form_params,
680
+ :body => post_body,
681
+ :auth_names => auth_names,
682
+ :return_type => return_type
683
+ )
684
+
685
+ begin
686
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
687
+ rescue Dropbox::Sign::ApiError => e
688
+ if e.code === 200
689
+ body = @api_client.convert_to_type(
690
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
691
+ "Dropbox::Sign::FileResponseDataUri"
692
+ )
693
+
694
+ fail ApiError.new(:code => e.code,
695
+ :response_headers => e.response_headers,
696
+ :response_body => body),
697
+ e.message
698
+ end
699
+
700
+ range_code = "4XX".split('').first
701
+ range_code_left = "#{range_code}00".to_i
702
+ range_code_right = "#{range_code}99".to_i
703
+ if e.code >= range_code_left && e.code <= range_code_right
704
+ body = @api_client.convert_to_type(
705
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
706
+ "Dropbox::Sign::ErrorResponse"
707
+ )
708
+
709
+ fail ApiError.new(:code => e.code,
710
+ :response_headers => e.response_headers,
711
+ :response_body => body),
712
+ e.message
713
+ end
714
+
715
+ end
716
+
717
+ if @api_client.config.debugging
718
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_files_as_data_uri\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
719
+ end
720
+ return data, status_code, headers
721
+ end
722
+
723
+ # Download Files as File Url
724
+ # 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.
725
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
726
+ # @param [Hash] opts the optional parameters
727
+ # @return [FileResponse]
728
+ def signature_request_files_as_file_url(signature_request_id, opts = {})
729
+ data, _status_code, _headers = signature_request_files_as_file_url_with_http_info(signature_request_id, opts)
730
+ data
731
+ end
732
+
733
+ # Download Files as File Url
734
+ # Obtain a copy of the current documents specified by the &#x60;signature_request_id&#x60; parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead.
735
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
736
+ # @param [Hash] opts the optional parameters
737
+ # @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
738
+ def signature_request_files_as_file_url_with_http_info(signature_request_id, opts = {})
739
+ if @api_client.config.debugging
740
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_files_as_file_url ...'
741
+ end
742
+ # verify the required parameter 'signature_request_id' is set
743
+ if @api_client.config.client_side_validation && signature_request_id.nil?
744
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_files_as_file_url"
745
+ end
746
+ # resource path
747
+ local_var_path = '/signature_request/files_as_file_url/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
748
+
749
+ # query parameters
750
+ query_params = opts[:query_params] || {}
751
+
752
+ # header parameters
753
+ header_params = opts[:header_params] || {}
754
+ # HTTP header 'Accept' (if needed)
755
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
756
+
757
+ post_body = {}
758
+ form_params = opts[:form_params] || {}
759
+
760
+ # http body (model)
761
+ post_body = opts[:debug_body]
762
+
763
+ # return_type
764
+ return_type = opts[:debug_return_type] || 'FileResponse'
765
+
766
+ # auth_names
767
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
768
+
769
+ new_options = opts.merge(
770
+ :operation => :"SignatureRequestApi.signature_request_files_as_file_url",
771
+ :header_params => header_params,
772
+ :query_params => query_params,
773
+ :form_params => form_params,
774
+ :body => post_body,
775
+ :auth_names => auth_names,
776
+ :return_type => return_type
777
+ )
778
+
779
+ begin
780
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
781
+ rescue Dropbox::Sign::ApiError => e
782
+ if e.code === 200
783
+ body = @api_client.convert_to_type(
784
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
785
+ "Dropbox::Sign::FileResponse"
786
+ )
787
+
788
+ fail ApiError.new(:code => e.code,
789
+ :response_headers => e.response_headers,
790
+ :response_body => body),
791
+ e.message
792
+ end
793
+
794
+ range_code = "4XX".split('').first
795
+ range_code_left = "#{range_code}00".to_i
796
+ range_code_right = "#{range_code}99".to_i
797
+ if e.code >= range_code_left && e.code <= range_code_right
798
+ body = @api_client.convert_to_type(
799
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
800
+ "Dropbox::Sign::ErrorResponse"
801
+ )
802
+
803
+ fail ApiError.new(:code => e.code,
804
+ :response_headers => e.response_headers,
805
+ :response_body => body),
806
+ e.message
807
+ end
808
+
809
+ end
810
+
811
+ if @api_client.config.debugging
812
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_files_as_file_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
813
+ end
814
+ return data, status_code, headers
815
+ end
816
+
817
+ # Get Signature Request
818
+ # Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
819
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
820
+ # @param [Hash] opts the optional parameters
821
+ # @return [SignatureRequestGetResponse]
822
+ def signature_request_get(signature_request_id, opts = {})
823
+ data, _status_code, _headers = signature_request_get_with_http_info(signature_request_id, opts)
824
+ data
825
+ end
826
+
827
+ # Get Signature Request
828
+ # Returns the status of the SignatureRequest specified by the &#x60;signature_request_id&#x60; parameter.
829
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
830
+ # @param [Hash] opts the optional parameters
831
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
832
+ def signature_request_get_with_http_info(signature_request_id, opts = {})
833
+ if @api_client.config.debugging
834
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_get ...'
835
+ end
836
+ # verify the required parameter 'signature_request_id' is set
837
+ if @api_client.config.client_side_validation && signature_request_id.nil?
838
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_get"
839
+ end
840
+ # resource path
841
+ local_var_path = '/signature_request/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
842
+
843
+ # query parameters
844
+ query_params = opts[:query_params] || {}
845
+
846
+ # header parameters
847
+ header_params = opts[:header_params] || {}
848
+ # HTTP header 'Accept' (if needed)
849
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
850
+
851
+ post_body = {}
852
+ form_params = opts[:form_params] || {}
853
+
854
+ # http body (model)
855
+ post_body = opts[:debug_body]
856
+
857
+ # return_type
858
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
859
+
860
+ # auth_names
861
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
862
+
863
+ new_options = opts.merge(
864
+ :operation => :"SignatureRequestApi.signature_request_get",
865
+ :header_params => header_params,
866
+ :query_params => query_params,
867
+ :form_params => form_params,
868
+ :body => post_body,
869
+ :auth_names => auth_names,
870
+ :return_type => return_type
871
+ )
872
+
873
+ begin
874
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
875
+ rescue Dropbox::Sign::ApiError => e
876
+ if e.code === 200
877
+ body = @api_client.convert_to_type(
878
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
879
+ "Dropbox::Sign::SignatureRequestGetResponse"
880
+ )
881
+
882
+ fail ApiError.new(:code => e.code,
883
+ :response_headers => e.response_headers,
884
+ :response_body => body),
885
+ e.message
886
+ end
887
+
888
+ range_code = "4XX".split('').first
889
+ range_code_left = "#{range_code}00".to_i
890
+ range_code_right = "#{range_code}99".to_i
891
+ if e.code >= range_code_left && e.code <= range_code_right
892
+ body = @api_client.convert_to_type(
893
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
894
+ "Dropbox::Sign::ErrorResponse"
895
+ )
896
+
897
+ fail ApiError.new(:code => e.code,
898
+ :response_headers => e.response_headers,
899
+ :response_body => body),
900
+ e.message
901
+ end
902
+
903
+ end
904
+
905
+ if @api_client.config.debugging
906
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
907
+ end
908
+ return data, status_code, headers
909
+ end
910
+
911
+ # List Signature Requests
912
+ # 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.
913
+ # @param [Hash] opts the optional parameters
914
+ # @option opts [String] :account_id Which account to return SignatureRequests for. Must be a team member. Use &#x60;all&#x60; to indicate all team members. Defaults to your account.
915
+ # @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to &#x60;1&#x60;. (default to 1)
916
+ # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;. (default to 20)
917
+ # @option opts [String] :query String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
918
+ # @return [SignatureRequestListResponse]
919
+ def signature_request_list(opts = {})
920
+ data, _status_code, _headers = signature_request_list_with_http_info(opts)
921
+ data
922
+ end
923
+
924
+ # List Signature Requests
925
+ # 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.
926
+ # @param [Hash] opts the optional parameters
927
+ # @option opts [String] :account_id Which account to return SignatureRequests for. Must be a team member. Use &#x60;all&#x60; to indicate all team members. Defaults to your account.
928
+ # @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to &#x60;1&#x60;.
929
+ # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;.
930
+ # @option opts [String] :query String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
931
+ # @return [Array<(SignatureRequestListResponse, Integer, Hash)>] SignatureRequestListResponse data, response status code and response headers
932
+ def signature_request_list_with_http_info(opts = {})
933
+ if @api_client.config.debugging
934
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_list ...'
935
+ end
936
+ # resource path
937
+ local_var_path = '/signature_request/list'
938
+
939
+ # query parameters
940
+ query_params = opts[:query_params] || {}
941
+ query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
942
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
943
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
944
+ query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
945
+
946
+ # header parameters
947
+ header_params = opts[:header_params] || {}
948
+ # HTTP header 'Accept' (if needed)
949
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
950
+
951
+ post_body = {}
952
+ form_params = opts[:form_params] || {}
953
+
954
+ # http body (model)
955
+ post_body = opts[:debug_body]
956
+
957
+ # return_type
958
+ return_type = opts[:debug_return_type] || 'SignatureRequestListResponse'
959
+
960
+ # auth_names
961
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
962
+
963
+ new_options = opts.merge(
964
+ :operation => :"SignatureRequestApi.signature_request_list",
965
+ :header_params => header_params,
966
+ :query_params => query_params,
967
+ :form_params => form_params,
968
+ :body => post_body,
969
+ :auth_names => auth_names,
970
+ :return_type => return_type
971
+ )
972
+
973
+ begin
974
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
975
+ rescue Dropbox::Sign::ApiError => e
976
+ if e.code === 200
977
+ body = @api_client.convert_to_type(
978
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
979
+ "Dropbox::Sign::SignatureRequestListResponse"
980
+ )
981
+
982
+ fail ApiError.new(:code => e.code,
983
+ :response_headers => e.response_headers,
984
+ :response_body => body),
985
+ e.message
986
+ end
987
+
988
+ range_code = "4XX".split('').first
989
+ range_code_left = "#{range_code}00".to_i
990
+ range_code_right = "#{range_code}99".to_i
991
+ if e.code >= range_code_left && e.code <= range_code_right
992
+ body = @api_client.convert_to_type(
993
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
994
+ "Dropbox::Sign::ErrorResponse"
995
+ )
996
+
997
+ fail ApiError.new(:code => e.code,
998
+ :response_headers => e.response_headers,
999
+ :response_body => body),
1000
+ e.message
1001
+ end
1002
+
1003
+ end
1004
+
1005
+ if @api_client.config.debugging
1006
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1007
+ end
1008
+ return data, status_code, headers
1009
+ end
1010
+
1011
+ # Release On-Hold Signature Request
1012
+ # 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.
1013
+ # @param signature_request_id [String] The id of the SignatureRequest to release.
1014
+ # @param [Hash] opts the optional parameters
1015
+ # @return [SignatureRequestGetResponse]
1016
+ def signature_request_release_hold(signature_request_id, opts = {})
1017
+ data, _status_code, _headers = signature_request_release_hold_with_http_info(signature_request_id, opts)
1018
+ data
1019
+ end
1020
+
1021
+ # Release On-Hold Signature Request
1022
+ # 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.
1023
+ # @param signature_request_id [String] The id of the SignatureRequest to release.
1024
+ # @param [Hash] opts the optional parameters
1025
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
1026
+ def signature_request_release_hold_with_http_info(signature_request_id, opts = {})
1027
+ if @api_client.config.debugging
1028
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_release_hold ...'
1029
+ end
1030
+ # verify the required parameter 'signature_request_id' is set
1031
+ if @api_client.config.client_side_validation && signature_request_id.nil?
1032
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_release_hold"
1033
+ end
1034
+ # resource path
1035
+ local_var_path = '/signature_request/release_hold/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
1036
+
1037
+ # query parameters
1038
+ query_params = opts[:query_params] || {}
1039
+
1040
+ # header parameters
1041
+ header_params = opts[:header_params] || {}
1042
+ # HTTP header 'Accept' (if needed)
1043
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1044
+
1045
+ post_body = {}
1046
+ form_params = opts[:form_params] || {}
1047
+
1048
+ # http body (model)
1049
+ post_body = opts[:debug_body]
1050
+
1051
+ # return_type
1052
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
1053
+
1054
+ # auth_names
1055
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
1056
+
1057
+ new_options = opts.merge(
1058
+ :operation => :"SignatureRequestApi.signature_request_release_hold",
1059
+ :header_params => header_params,
1060
+ :query_params => query_params,
1061
+ :form_params => form_params,
1062
+ :body => post_body,
1063
+ :auth_names => auth_names,
1064
+ :return_type => return_type
1065
+ )
1066
+
1067
+ begin
1068
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1069
+ rescue Dropbox::Sign::ApiError => e
1070
+ if e.code === 200
1071
+ body = @api_client.convert_to_type(
1072
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1073
+ "Dropbox::Sign::SignatureRequestGetResponse"
1074
+ )
1075
+
1076
+ fail ApiError.new(:code => e.code,
1077
+ :response_headers => e.response_headers,
1078
+ :response_body => body),
1079
+ e.message
1080
+ end
1081
+
1082
+ range_code = "4XX".split('').first
1083
+ range_code_left = "#{range_code}00".to_i
1084
+ range_code_right = "#{range_code}99".to_i
1085
+ if e.code >= range_code_left && e.code <= range_code_right
1086
+ body = @api_client.convert_to_type(
1087
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1088
+ "Dropbox::Sign::ErrorResponse"
1089
+ )
1090
+
1091
+ fail ApiError.new(:code => e.code,
1092
+ :response_headers => e.response_headers,
1093
+ :response_body => body),
1094
+ e.message
1095
+ end
1096
+
1097
+ end
1098
+
1099
+ if @api_client.config.debugging
1100
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_release_hold\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1101
+ end
1102
+ return data, status_code, headers
1103
+ end
1104
+
1105
+ # Send Request Reminder
1106
+ # 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.
1107
+ # @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
1108
+ # @param signature_request_remind_request [SignatureRequestRemindRequest]
1109
+ # @param [Hash] opts the optional parameters
1110
+ # @return [SignatureRequestGetResponse]
1111
+ def signature_request_remind(signature_request_id, signature_request_remind_request, opts = {})
1112
+ data, _status_code, _headers = signature_request_remind_with_http_info(signature_request_id, signature_request_remind_request, opts)
1113
+ data
1114
+ end
1115
+
1116
+ # Send Request Reminder
1117
+ # 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.
1118
+ # @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
1119
+ # @param signature_request_remind_request [SignatureRequestRemindRequest]
1120
+ # @param [Hash] opts the optional parameters
1121
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
1122
+ def signature_request_remind_with_http_info(signature_request_id, signature_request_remind_request, opts = {})
1123
+ if @api_client.config.debugging
1124
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_remind ...'
1125
+ end
1126
+ # verify the required parameter 'signature_request_id' is set
1127
+ if @api_client.config.client_side_validation && signature_request_id.nil?
1128
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_remind"
1129
+ end
1130
+ # verify the required parameter 'signature_request_remind_request' is set
1131
+ if @api_client.config.client_side_validation && signature_request_remind_request.nil?
1132
+ fail ArgumentError, "Missing the required parameter 'signature_request_remind_request' when calling SignatureRequestApi.signature_request_remind"
1133
+ end
1134
+ # resource path
1135
+ local_var_path = '/signature_request/remind/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
1136
+
1137
+ # query parameters
1138
+ query_params = opts[:query_params] || {}
1139
+
1140
+ # header parameters
1141
+ header_params = opts[:header_params] || {}
1142
+ # HTTP header 'Accept' (if needed)
1143
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1144
+ # HTTP header 'Content-Type'
1145
+ content_type = @api_client.select_header_content_type(['application/json'])
1146
+ if !content_type.nil?
1147
+ header_params['Content-Type'] = content_type
1148
+ end
1149
+
1150
+ post_body = {}
1151
+ form_params = opts[:form_params] || {}
1152
+ result = @api_client.generate_form_data(
1153
+ signature_request_remind_request,
1154
+ Dropbox::Sign::SignatureRequestRemindRequest.openapi_types
1155
+ )
1156
+
1157
+ # form parameters
1158
+ if result[:has_file]
1159
+ form_params = opts[:form_params] || result[:params]
1160
+ header_params['Content-Type'] = 'multipart/form-data'
1161
+ else
1162
+ # http body (model)
1163
+ post_body = opts[:debug_body] || result[:params]
1164
+ end
1165
+
1166
+ # return_type
1167
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
1168
+
1169
+ # auth_names
1170
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
1171
+
1172
+ new_options = opts.merge(
1173
+ :operation => :"SignatureRequestApi.signature_request_remind",
1174
+ :header_params => header_params,
1175
+ :query_params => query_params,
1176
+ :form_params => form_params,
1177
+ :body => post_body,
1178
+ :auth_names => auth_names,
1179
+ :return_type => return_type
1180
+ )
1181
+
1182
+ begin
1183
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1184
+ rescue Dropbox::Sign::ApiError => e
1185
+ if e.code === 200
1186
+ body = @api_client.convert_to_type(
1187
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1188
+ "Dropbox::Sign::SignatureRequestGetResponse"
1189
+ )
1190
+
1191
+ fail ApiError.new(:code => e.code,
1192
+ :response_headers => e.response_headers,
1193
+ :response_body => body),
1194
+ e.message
1195
+ end
1196
+
1197
+ range_code = "4XX".split('').first
1198
+ range_code_left = "#{range_code}00".to_i
1199
+ range_code_right = "#{range_code}99".to_i
1200
+ if e.code >= range_code_left && e.code <= range_code_right
1201
+ body = @api_client.convert_to_type(
1202
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1203
+ "Dropbox::Sign::ErrorResponse"
1204
+ )
1205
+
1206
+ fail ApiError.new(:code => e.code,
1207
+ :response_headers => e.response_headers,
1208
+ :response_body => body),
1209
+ e.message
1210
+ end
1211
+
1212
+ end
1213
+
1214
+ if @api_client.config.debugging
1215
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_remind\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1216
+ end
1217
+ return data, status_code, headers
1218
+ end
1219
+
1220
+ # Remove Signature Request Access
1221
+ # 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.
1222
+ # @param signature_request_id [String] The id of the SignatureRequest to remove.
1223
+ # @param [Hash] opts the optional parameters
1224
+ # @return [nil]
1225
+ def signature_request_remove(signature_request_id, opts = {})
1226
+ signature_request_remove_with_http_info(signature_request_id, opts)
1227
+ nil
1228
+ end
1229
+
1230
+ # Remove Signature Request Access
1231
+ # 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.
1232
+ # @param signature_request_id [String] The id of the SignatureRequest to remove.
1233
+ # @param [Hash] opts the optional parameters
1234
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1235
+ def signature_request_remove_with_http_info(signature_request_id, opts = {})
1236
+ if @api_client.config.debugging
1237
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_remove ...'
1238
+ end
1239
+ # verify the required parameter 'signature_request_id' is set
1240
+ if @api_client.config.client_side_validation && signature_request_id.nil?
1241
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_remove"
1242
+ end
1243
+ # resource path
1244
+ local_var_path = '/signature_request/remove/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
1245
+
1246
+ # query parameters
1247
+ query_params = opts[:query_params] || {}
1248
+
1249
+ # header parameters
1250
+ header_params = opts[:header_params] || {}
1251
+ # HTTP header 'Accept' (if needed)
1252
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1253
+
1254
+ post_body = {}
1255
+ form_params = opts[:form_params] || {}
1256
+
1257
+ # http body (model)
1258
+ post_body = opts[:debug_body]
1259
+
1260
+ # return_type
1261
+ return_type = opts[:debug_return_type]
1262
+
1263
+ # auth_names
1264
+ auth_names = opts[:debug_auth_names] || ['api_key']
1265
+
1266
+ new_options = opts.merge(
1267
+ :operation => :"SignatureRequestApi.signature_request_remove",
1268
+ :header_params => header_params,
1269
+ :query_params => query_params,
1270
+ :form_params => form_params,
1271
+ :body => post_body,
1272
+ :auth_names => auth_names,
1273
+ :return_type => return_type
1274
+ )
1275
+
1276
+ begin
1277
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1278
+ rescue Dropbox::Sign::ApiError => e
1279
+ end
1280
+
1281
+ if @api_client.config.debugging
1282
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1283
+ end
1284
+ return data, status_code, headers
1285
+ end
1286
+
1287
+ # Send Signature Request
1288
+ # 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.
1289
+ # @param signature_request_send_request [SignatureRequestSendRequest]
1290
+ # @param [Hash] opts the optional parameters
1291
+ # @return [SignatureRequestGetResponse]
1292
+ def signature_request_send(signature_request_send_request, opts = {})
1293
+ data, _status_code, _headers = signature_request_send_with_http_info(signature_request_send_request, opts)
1294
+ data
1295
+ end
1296
+
1297
+ # Send Signature Request
1298
+ # Creates and sends a new SignatureRequest with the submitted documents. If &#x60;form_fields_per_document&#x60; 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.
1299
+ # @param signature_request_send_request [SignatureRequestSendRequest]
1300
+ # @param [Hash] opts the optional parameters
1301
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
1302
+ def signature_request_send_with_http_info(signature_request_send_request, opts = {})
1303
+ if @api_client.config.debugging
1304
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_send ...'
1305
+ end
1306
+ # verify the required parameter 'signature_request_send_request' is set
1307
+ if @api_client.config.client_side_validation && signature_request_send_request.nil?
1308
+ fail ArgumentError, "Missing the required parameter 'signature_request_send_request' when calling SignatureRequestApi.signature_request_send"
1309
+ end
1310
+ # resource path
1311
+ local_var_path = '/signature_request/send'
1312
+
1313
+ # query parameters
1314
+ query_params = opts[:query_params] || {}
1315
+
1316
+ # header parameters
1317
+ header_params = opts[:header_params] || {}
1318
+ # HTTP header 'Accept' (if needed)
1319
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1320
+ # HTTP header 'Content-Type'
1321
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
1322
+ if !content_type.nil?
1323
+ header_params['Content-Type'] = content_type
1324
+ end
1325
+
1326
+ post_body = {}
1327
+ form_params = opts[:form_params] || {}
1328
+ result = @api_client.generate_form_data(
1329
+ signature_request_send_request,
1330
+ Dropbox::Sign::SignatureRequestSendRequest.openapi_types
1331
+ )
1332
+
1333
+ # form parameters
1334
+ if result[:has_file]
1335
+ form_params = opts[:form_params] || result[:params]
1336
+ header_params['Content-Type'] = 'multipart/form-data'
1337
+ else
1338
+ # http body (model)
1339
+ post_body = opts[:debug_body] || result[:params]
1340
+ end
1341
+
1342
+ # return_type
1343
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
1344
+
1345
+ # auth_names
1346
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
1347
+
1348
+ new_options = opts.merge(
1349
+ :operation => :"SignatureRequestApi.signature_request_send",
1350
+ :header_params => header_params,
1351
+ :query_params => query_params,
1352
+ :form_params => form_params,
1353
+ :body => post_body,
1354
+ :auth_names => auth_names,
1355
+ :return_type => return_type
1356
+ )
1357
+
1358
+ begin
1359
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1360
+ rescue Dropbox::Sign::ApiError => e
1361
+ if e.code === 200
1362
+ body = @api_client.convert_to_type(
1363
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1364
+ "Dropbox::Sign::SignatureRequestGetResponse"
1365
+ )
1366
+
1367
+ fail ApiError.new(:code => e.code,
1368
+ :response_headers => e.response_headers,
1369
+ :response_body => body),
1370
+ e.message
1371
+ end
1372
+
1373
+ range_code = "4XX".split('').first
1374
+ range_code_left = "#{range_code}00".to_i
1375
+ range_code_right = "#{range_code}99".to_i
1376
+ if e.code >= range_code_left && e.code <= range_code_right
1377
+ body = @api_client.convert_to_type(
1378
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1379
+ "Dropbox::Sign::ErrorResponse"
1380
+ )
1381
+
1382
+ fail ApiError.new(:code => e.code,
1383
+ :response_headers => e.response_headers,
1384
+ :response_body => body),
1385
+ e.message
1386
+ end
1387
+
1388
+ end
1389
+
1390
+ if @api_client.config.debugging
1391
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1392
+ end
1393
+ return data, status_code, headers
1394
+ end
1395
+
1396
+ # Send with Template
1397
+ # Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.
1398
+ # @param signature_request_send_with_template_request [SignatureRequestSendWithTemplateRequest]
1399
+ # @param [Hash] opts the optional parameters
1400
+ # @return [SignatureRequestGetResponse]
1401
+ def signature_request_send_with_template(signature_request_send_with_template_request, opts = {})
1402
+ data, _status_code, _headers = signature_request_send_with_template_with_http_info(signature_request_send_with_template_request, opts)
1403
+ data
1404
+ end
1405
+
1406
+ # Send with Template
1407
+ # Creates and sends a new SignatureRequest based off of the Template(s) specified with the &#x60;template_ids&#x60; parameter.
1408
+ # @param signature_request_send_with_template_request [SignatureRequestSendWithTemplateRequest]
1409
+ # @param [Hash] opts the optional parameters
1410
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
1411
+ def signature_request_send_with_template_with_http_info(signature_request_send_with_template_request, opts = {})
1412
+ if @api_client.config.debugging
1413
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_send_with_template ...'
1414
+ end
1415
+ # verify the required parameter 'signature_request_send_with_template_request' is set
1416
+ if @api_client.config.client_side_validation && signature_request_send_with_template_request.nil?
1417
+ fail ArgumentError, "Missing the required parameter 'signature_request_send_with_template_request' when calling SignatureRequestApi.signature_request_send_with_template"
1418
+ end
1419
+ # resource path
1420
+ local_var_path = '/signature_request/send_with_template'
1421
+
1422
+ # query parameters
1423
+ query_params = opts[:query_params] || {}
1424
+
1425
+ # header parameters
1426
+ header_params = opts[:header_params] || {}
1427
+ # HTTP header 'Accept' (if needed)
1428
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1429
+ # HTTP header 'Content-Type'
1430
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
1431
+ if !content_type.nil?
1432
+ header_params['Content-Type'] = content_type
1433
+ end
1434
+
1435
+ post_body = {}
1436
+ form_params = opts[:form_params] || {}
1437
+ result = @api_client.generate_form_data(
1438
+ signature_request_send_with_template_request,
1439
+ Dropbox::Sign::SignatureRequestSendWithTemplateRequest.openapi_types
1440
+ )
1441
+
1442
+ # form parameters
1443
+ if result[:has_file]
1444
+ form_params = opts[:form_params] || result[:params]
1445
+ header_params['Content-Type'] = 'multipart/form-data'
1446
+ else
1447
+ # http body (model)
1448
+ post_body = opts[:debug_body] || result[:params]
1449
+ end
1450
+
1451
+ # return_type
1452
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
1453
+
1454
+ # auth_names
1455
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
1456
+
1457
+ new_options = opts.merge(
1458
+ :operation => :"SignatureRequestApi.signature_request_send_with_template",
1459
+ :header_params => header_params,
1460
+ :query_params => query_params,
1461
+ :form_params => form_params,
1462
+ :body => post_body,
1463
+ :auth_names => auth_names,
1464
+ :return_type => return_type
1465
+ )
1466
+
1467
+ begin
1468
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1469
+ rescue Dropbox::Sign::ApiError => e
1470
+ if e.code === 200
1471
+ body = @api_client.convert_to_type(
1472
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1473
+ "Dropbox::Sign::SignatureRequestGetResponse"
1474
+ )
1475
+
1476
+ fail ApiError.new(:code => e.code,
1477
+ :response_headers => e.response_headers,
1478
+ :response_body => body),
1479
+ e.message
1480
+ end
1481
+
1482
+ range_code = "4XX".split('').first
1483
+ range_code_left = "#{range_code}00".to_i
1484
+ range_code_right = "#{range_code}99".to_i
1485
+ if e.code >= range_code_left && e.code <= range_code_right
1486
+ body = @api_client.convert_to_type(
1487
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1488
+ "Dropbox::Sign::ErrorResponse"
1489
+ )
1490
+
1491
+ fail ApiError.new(:code => e.code,
1492
+ :response_headers => e.response_headers,
1493
+ :response_body => body),
1494
+ e.message
1495
+ end
1496
+
1497
+ end
1498
+
1499
+ if @api_client.config.debugging
1500
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_send_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1501
+ end
1502
+ return data, status_code, headers
1503
+ end
1504
+
1505
+ # Update Signature Request
1506
+ # 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.
1507
+ # @param signature_request_id [String] The id of the SignatureRequest to update.
1508
+ # @param signature_request_update_request [SignatureRequestUpdateRequest]
1509
+ # @param [Hash] opts the optional parameters
1510
+ # @return [SignatureRequestGetResponse]
1511
+ def signature_request_update(signature_request_id, signature_request_update_request, opts = {})
1512
+ data, _status_code, _headers = signature_request_update_with_http_info(signature_request_id, signature_request_update_request, opts)
1513
+ data
1514
+ end
1515
+
1516
+ # Update Signature Request
1517
+ # Updates the email address and/or the name for a given signer on a signature request. You can listen for the &#x60;signature_request_email_bounce&#x60; 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.
1518
+ # @param signature_request_id [String] The id of the SignatureRequest to update.
1519
+ # @param signature_request_update_request [SignatureRequestUpdateRequest]
1520
+ # @param [Hash] opts the optional parameters
1521
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
1522
+ def signature_request_update_with_http_info(signature_request_id, signature_request_update_request, opts = {})
1523
+ if @api_client.config.debugging
1524
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_update ...'
1525
+ end
1526
+ # verify the required parameter 'signature_request_id' is set
1527
+ if @api_client.config.client_side_validation && signature_request_id.nil?
1528
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_update"
1529
+ end
1530
+ # verify the required parameter 'signature_request_update_request' is set
1531
+ if @api_client.config.client_side_validation && signature_request_update_request.nil?
1532
+ fail ArgumentError, "Missing the required parameter 'signature_request_update_request' when calling SignatureRequestApi.signature_request_update"
1533
+ end
1534
+ # resource path
1535
+ local_var_path = '/signature_request/update/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
1536
+
1537
+ # query parameters
1538
+ query_params = opts[:query_params] || {}
1539
+
1540
+ # header parameters
1541
+ header_params = opts[:header_params] || {}
1542
+ # HTTP header 'Accept' (if needed)
1543
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1544
+ # HTTP header 'Content-Type'
1545
+ content_type = @api_client.select_header_content_type(['application/json'])
1546
+ if !content_type.nil?
1547
+ header_params['Content-Type'] = content_type
1548
+ end
1549
+
1550
+ post_body = {}
1551
+ form_params = opts[:form_params] || {}
1552
+ result = @api_client.generate_form_data(
1553
+ signature_request_update_request,
1554
+ Dropbox::Sign::SignatureRequestUpdateRequest.openapi_types
1555
+ )
1556
+
1557
+ # form parameters
1558
+ if result[:has_file]
1559
+ form_params = opts[:form_params] || result[:params]
1560
+ header_params['Content-Type'] = 'multipart/form-data'
1561
+ else
1562
+ # http body (model)
1563
+ post_body = opts[:debug_body] || result[:params]
1564
+ end
1565
+
1566
+ # return_type
1567
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
1568
+
1569
+ # auth_names
1570
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
1571
+
1572
+ new_options = opts.merge(
1573
+ :operation => :"SignatureRequestApi.signature_request_update",
1574
+ :header_params => header_params,
1575
+ :query_params => query_params,
1576
+ :form_params => form_params,
1577
+ :body => post_body,
1578
+ :auth_names => auth_names,
1579
+ :return_type => return_type
1580
+ )
1581
+
1582
+ begin
1583
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1584
+ rescue Dropbox::Sign::ApiError => e
1585
+ if e.code === 200
1586
+ body = @api_client.convert_to_type(
1587
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1588
+ "Dropbox::Sign::SignatureRequestGetResponse"
1589
+ )
1590
+
1591
+ fail ApiError.new(:code => e.code,
1592
+ :response_headers => e.response_headers,
1593
+ :response_body => body),
1594
+ e.message
1595
+ end
1596
+
1597
+ range_code = "4XX".split('').first
1598
+ range_code_left = "#{range_code}00".to_i
1599
+ range_code_right = "#{range_code}99".to_i
1600
+ if e.code >= range_code_left && e.code <= range_code_right
1601
+ body = @api_client.convert_to_type(
1602
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1603
+ "Dropbox::Sign::ErrorResponse"
1604
+ )
1605
+
1606
+ fail ApiError.new(:code => e.code,
1607
+ :response_headers => e.response_headers,
1608
+ :response_body => body),
1609
+ e.message
1610
+ end
1611
+
1612
+ end
1613
+
1614
+ if @api_client.config.debugging
1615
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1616
+ end
1617
+ return data, status_code, headers
1618
+ end
1619
+ end
1620
+ end