dropbox-sign 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (412) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -5
  3. data/README.md +23 -16
  4. data/VERSION +1 -1
  5. data/docs/AccountApi.md +33 -38
  6. data/docs/ApiAppApi.md +64 -64
  7. data/docs/BulkSendJobApi.md +21 -21
  8. data/docs/EmbeddedApi.md +22 -22
  9. data/docs/FaxApi.md +57 -55
  10. data/docs/FaxLineAddUserRequest.md +1 -1
  11. data/docs/FaxLineApi.md +74 -63
  12. data/docs/FaxLineCreateRequest.md +4 -4
  13. data/docs/FaxLineDeleteRequest.md +1 -1
  14. data/docs/FaxLineRemoveUserRequest.md +3 -3
  15. data/docs/FaxSendRequest.md +5 -5
  16. data/docs/OAuthApi.md +27 -15
  17. data/docs/ReportApi.md +14 -13
  18. data/docs/SignatureRequestApi.md +822 -311
  19. data/docs/SignatureRequestEditEmbeddedRequest.md +33 -0
  20. data/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +24 -0
  21. data/docs/SignatureRequestEditRequest.md +34 -0
  22. data/docs/SignatureRequestEditWithTemplateRequest.md +25 -0
  23. data/docs/TeamApi.md +84 -95
  24. data/docs/TemplateApi.md +210 -166
  25. data/docs/UnclaimedDraftApi.md +77 -91
  26. data/dropbox-sign.gemspec +1 -1
  27. data/examples/AccountCreateExample.rb +20 -0
  28. data/examples/AccountCreateOauthExample.rb +22 -0
  29. data/examples/AccountGetExample.rb +15 -0
  30. data/examples/AccountUpdateExample.rb +21 -0
  31. data/examples/AccountVerifyExample.rb +20 -0
  32. data/examples/ApiAppCreateExample.rb +37 -0
  33. data/examples/ApiAppDeleteExample.rb +15 -0
  34. data/examples/ApiAppGetExample.rb +17 -0
  35. data/examples/ApiAppListExample.rb +20 -0
  36. data/examples/ApiAppUpdateExample.rb +39 -0
  37. data/examples/BulkSendJobGetExample.rb +21 -0
  38. data/examples/BulkSendJobListExample.rb +20 -0
  39. data/examples/EmbeddedEditUrlExample.rb +27 -0
  40. data/examples/EmbeddedSignUrlExample.rb +17 -0
  41. data/examples/FaxDeleteExample.rb +14 -0
  42. data/examples/FaxFilesExample.rb +16 -0
  43. data/examples/FaxGetExample.rb +16 -0
  44. data/examples/FaxLineAddUserExample.rb +20 -0
  45. data/examples/FaxLineAreaCodeGetExample.rb +16 -0
  46. data/examples/FaxLineCreateExample.rb +20 -0
  47. data/examples/FaxLineDeleteExample.rb +17 -0
  48. data/examples/FaxLineGetExample.rb +16 -0
  49. data/examples/FaxLineListExample.rb +21 -0
  50. data/examples/FaxLineRemoveUserExample.rb +20 -0
  51. data/examples/FaxListExample.rb +19 -0
  52. data/examples/FaxSendExample.rb +28 -0
  53. data/examples/OauthTokenGenerateExample.rb +22 -0
  54. data/examples/OauthTokenRefreshExample.rb +19 -0
  55. data/examples/ReportCreateExample.rb +24 -0
  56. data/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb +84 -0
  57. data/examples/SignatureRequestBulkSendWithTemplateExample.rb +84 -0
  58. data/examples/SignatureRequestCancelExample.rb +15 -0
  59. data/examples/SignatureRequestCreateEmbeddedExample.rb +55 -0
  60. data/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb +81 -0
  61. data/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb +44 -0
  62. data/examples/SignatureRequestEditEmbeddedExample.rb +56 -0
  63. data/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb +82 -0
  64. data/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb +45 -0
  65. data/examples/SignatureRequestEditExample.rb +66 -0
  66. data/examples/SignatureRequestEditGroupedSignersExample.rb +92 -0
  67. data/examples/SignatureRequestEditWithTemplateExample.rb +64 -0
  68. data/examples/SignatureRequestFilesAsDataUriExample.rb +17 -0
  69. data/examples/SignatureRequestFilesAsFileUrlExample.rb +20 -0
  70. data/examples/SignatureRequestFilesExample.rb +20 -0
  71. data/examples/SignatureRequestGetExample.rb +17 -0
  72. data/examples/SignatureRequestListExample.rb +22 -0
  73. data/examples/SignatureRequestReleaseHoldExample.rb +17 -0
  74. data/examples/SignatureRequestRemindExample.rb +21 -0
  75. data/examples/SignatureRequestRemoveExample.rb +14 -0
  76. data/examples/SignatureRequestSendExample.rb +65 -0
  77. data/examples/SignatureRequestSendGroupedSignersExample.rb +91 -0
  78. data/examples/SignatureRequestSendWithTemplateExample.rb +63 -0
  79. data/examples/SignatureRequestUpdateExample.rb +22 -0
  80. data/examples/TeamAddMemberAccountIdExample.rb +23 -0
  81. data/examples/TeamAddMemberExample.rb +23 -0
  82. data/examples/TeamCreateExample.rb +20 -0
  83. data/examples/TeamDeleteExample.rb +13 -0
  84. data/examples/TeamGetExample.rb +15 -0
  85. data/examples/TeamInfoExample.rb +19 -0
  86. data/examples/TeamInvitesExample.rb +15 -0
  87. data/examples/TeamMembersExample.rb +21 -0
  88. data/examples/TeamRemoveMemberAccountIdExample.rb +20 -0
  89. data/examples/TeamRemoveMemberExample.rb +21 -0
  90. data/examples/TeamSubTeamsExample.rb +21 -0
  91. data/examples/TeamUpdateExample.rb +20 -0
  92. data/examples/TemplateAddUserExample.rb +21 -0
  93. data/examples/TemplateCreateEmbeddedDraftExample.rb +62 -0
  94. data/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb +108 -0
  95. data/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb +124 -0
  96. data/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb +96 -0
  97. data/examples/TemplateCreateExample.rb +96 -0
  98. data/examples/TemplateCreateFormFieldGroupsExample.rb +108 -0
  99. data/examples/TemplateCreateFormFieldRulesExample.rb +124 -0
  100. data/examples/TemplateCreateFormFieldsPerDocumentExample.rb +96 -0
  101. data/examples/TemplateDeleteExample.rb +15 -0
  102. data/examples/TemplateFilesAsDataUriExample.rb +17 -0
  103. data/examples/TemplateFilesAsFileUrlExample.rb +20 -0
  104. data/examples/TemplateFilesExample.rb +17 -0
  105. data/examples/TemplateGetExample.rb +17 -0
  106. data/examples/TemplateListExample.rb +22 -0
  107. data/examples/TemplateRemoveUserExample.rb +21 -0
  108. data/examples/TemplateUpdateFilesExample.rb +23 -0
  109. data/examples/UnclaimedDraftCreateEmbeddedExample.rb +25 -0
  110. data/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb +71 -0
  111. data/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb +87 -0
  112. data/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb +59 -0
  113. data/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb +44 -0
  114. data/examples/UnclaimedDraftCreateExample.rb +34 -0
  115. data/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb +70 -0
  116. data/examples/UnclaimedDraftCreateFormFieldRulesExample.rb +86 -0
  117. data/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb +58 -0
  118. data/examples/UnclaimedDraftEditAndResendExample.rb +22 -0
  119. data/lib/dropbox-sign/api/account_api.rb +1 -1
  120. data/lib/dropbox-sign/api/api_app_api.rb +1 -1
  121. data/lib/dropbox-sign/api/bulk_send_job_api.rb +1 -1
  122. data/lib/dropbox-sign/api/embedded_api.rb +1 -1
  123. data/lib/dropbox-sign/api/fax_api.rb +17 -17
  124. data/lib/dropbox-sign/api/fax_line_api.rb +23 -23
  125. data/lib/dropbox-sign/api/o_auth_api.rb +1 -1
  126. data/lib/dropbox-sign/api/report_api.rb +1 -1
  127. data/lib/dropbox-sign/api/signature_request_api.rb +461 -1
  128. data/lib/dropbox-sign/api/team_api.rb +1 -1
  129. data/lib/dropbox-sign/api/template_api.rb +1 -1
  130. data/lib/dropbox-sign/api/unclaimed_draft_api.rb +1 -1
  131. data/lib/dropbox-sign/api_client.rb +8 -9
  132. data/lib/dropbox-sign/api_error.rb +1 -1
  133. data/lib/dropbox-sign/configuration.rb +1 -1
  134. data/lib/dropbox-sign/event_callback_helper.rb +1 -1
  135. data/lib/dropbox-sign/models/account_create_request.rb +19 -3
  136. data/lib/dropbox-sign/models/account_create_response.rb +19 -3
  137. data/lib/dropbox-sign/models/account_get_response.rb +19 -3
  138. data/lib/dropbox-sign/models/account_response.rb +9 -3
  139. data/lib/dropbox-sign/models/account_response_quotas.rb +9 -3
  140. data/lib/dropbox-sign/models/account_response_usage.rb +9 -3
  141. data/lib/dropbox-sign/models/account_update_request.rb +9 -3
  142. data/lib/dropbox-sign/models/account_verify_request.rb +19 -3
  143. data/lib/dropbox-sign/models/account_verify_response.rb +9 -3
  144. data/lib/dropbox-sign/models/account_verify_response_account.rb +9 -3
  145. data/lib/dropbox-sign/models/api_app_create_request.rb +19 -3
  146. data/lib/dropbox-sign/models/api_app_get_response.rb +19 -3
  147. data/lib/dropbox-sign/models/api_app_list_response.rb +29 -3
  148. data/lib/dropbox-sign/models/api_app_response.rb +9 -3
  149. data/lib/dropbox-sign/models/api_app_response_o_auth.rb +9 -3
  150. data/lib/dropbox-sign/models/api_app_response_options.rb +9 -3
  151. data/lib/dropbox-sign/models/api_app_response_owner_account.rb +9 -3
  152. data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +9 -3
  153. data/lib/dropbox-sign/models/api_app_update_request.rb +9 -3
  154. data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +39 -3
  155. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +9 -3
  156. data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +29 -3
  157. data/lib/dropbox-sign/models/bulk_send_job_response.rb +9 -3
  158. data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +19 -3
  159. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +9 -3
  160. data/lib/dropbox-sign/models/embedded_edit_url_response.rb +19 -3
  161. data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +9 -3
  162. data/lib/dropbox-sign/models/embedded_sign_url_response.rb +19 -3
  163. data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +9 -3
  164. data/lib/dropbox-sign/models/error_response.rb +19 -3
  165. data/lib/dropbox-sign/models/error_response_error.rb +29 -3
  166. data/lib/dropbox-sign/models/event_callback_request.rb +19 -3
  167. data/lib/dropbox-sign/models/event_callback_request_event.rb +29 -3
  168. data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +9 -3
  169. data/lib/dropbox-sign/models/fax_get_response.rb +19 -3
  170. data/lib/dropbox-sign/models/fax_line_add_user_request.rb +20 -4
  171. data/lib/dropbox-sign/models/fax_line_area_code_get_country_enum.rb +1 -1
  172. data/lib/dropbox-sign/models/fax_line_area_code_get_province_enum.rb +1 -1
  173. data/lib/dropbox-sign/models/fax_line_area_code_get_response.rb +19 -3
  174. data/lib/dropbox-sign/models/fax_line_area_code_get_state_enum.rb +1 -1
  175. data/lib/dropbox-sign/models/fax_line_create_request.rb +23 -7
  176. data/lib/dropbox-sign/models/fax_line_delete_request.rb +20 -4
  177. data/lib/dropbox-sign/models/fax_line_list_response.rb +29 -3
  178. data/lib/dropbox-sign/models/fax_line_remove_user_request.rb +22 -6
  179. data/lib/dropbox-sign/models/fax_line_response.rb +19 -3
  180. data/lib/dropbox-sign/models/fax_line_response_fax_line.rb +9 -3
  181. data/lib/dropbox-sign/models/fax_list_response.rb +29 -3
  182. data/lib/dropbox-sign/models/fax_response.rb +89 -3
  183. data/lib/dropbox-sign/models/fax_response_transmission.rb +19 -3
  184. data/lib/dropbox-sign/models/fax_send_request.rb +24 -8
  185. data/lib/dropbox-sign/models/file_response.rb +29 -3
  186. data/lib/dropbox-sign/models/file_response_data_uri.rb +19 -3
  187. data/lib/dropbox-sign/models/list_info_response.rb +9 -3
  188. data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +59 -3
  189. data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +29 -3
  190. data/lib/dropbox-sign/models/o_auth_token_response.rb +9 -3
  191. data/lib/dropbox-sign/models/report_create_request.rb +29 -3
  192. data/lib/dropbox-sign/models/report_create_response.rb +19 -3
  193. data/lib/dropbox-sign/models/report_response.rb +9 -3
  194. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +29 -3
  195. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +19 -3
  196. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +19 -3
  197. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +39 -3
  198. data/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +604 -0
  199. data/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +521 -0
  200. data/lib/dropbox-sign/models/signature_request_edit_request.rb +600 -0
  201. data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +518 -0
  202. data/lib/dropbox-sign/models/signature_request_get_response.rb +19 -3
  203. data/lib/dropbox-sign/models/signature_request_list_response.rb +29 -3
  204. data/lib/dropbox-sign/models/signature_request_remind_request.rb +19 -3
  205. data/lib/dropbox-sign/models/signature_request_response.rb +9 -3
  206. data/lib/dropbox-sign/models/signature_request_response_attachment.rb +49 -3
  207. data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +29 -3
  208. data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +19 -3
  209. data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +19 -3
  210. data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +1 -1
  211. data/lib/dropbox-sign/models/signature_request_response_data_base.rb +9 -3
  212. data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +1 -1
  213. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +9 -3
  214. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +9 -3
  215. data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +9 -3
  216. data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +9 -3
  217. data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +9 -3
  218. data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +9 -3
  219. data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +9 -3
  220. data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +9 -3
  221. data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +9 -3
  222. data/lib/dropbox-sign/models/signature_request_response_signatures.rb +9 -3
  223. data/lib/dropbox-sign/models/signature_request_send_request.rb +9 -3
  224. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +29 -3
  225. data/lib/dropbox-sign/models/signature_request_update_request.rb +19 -3
  226. data/lib/dropbox-sign/models/sub_attachment.rb +29 -3
  227. data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +9 -3
  228. data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +29 -3
  229. data/lib/dropbox-sign/models/sub_cc.rb +29 -3
  230. data/lib/dropbox-sign/models/sub_custom_field.rb +19 -3
  231. data/lib/dropbox-sign/models/sub_editor_options.rb +9 -3
  232. data/lib/dropbox-sign/models/sub_field_options.rb +9 -3
  233. data/lib/dropbox-sign/models/sub_form_field_group.rb +39 -3
  234. data/lib/dropbox-sign/models/sub_form_field_rule.rb +29 -3
  235. data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +19 -3
  236. data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +19 -3
  237. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +99 -3
  238. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +29 -3
  239. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +19 -3
  240. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +19 -3
  241. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +19 -3
  242. data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +1 -1
  243. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +39 -3
  244. data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +19 -3
  245. data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +39 -3
  246. data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +19 -3
  247. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +19 -3
  248. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +19 -3
  249. data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +1 -1
  250. data/lib/dropbox-sign/models/sub_merge_field.rb +19 -3
  251. data/lib/dropbox-sign/models/sub_o_auth.rb +9 -3
  252. data/lib/dropbox-sign/models/sub_options.rb +9 -3
  253. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +29 -3
  254. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +29 -3
  255. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +39 -3
  256. data/lib/dropbox-sign/models/sub_signing_options.rb +9 -3
  257. data/lib/dropbox-sign/models/sub_team_response.rb +9 -3
  258. data/lib/dropbox-sign/models/sub_template_role.rb +9 -3
  259. data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +29 -3
  260. data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +39 -3
  261. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +9 -3
  262. data/lib/dropbox-sign/models/team_add_member_request.rb +9 -3
  263. data/lib/dropbox-sign/models/team_create_request.rb +9 -3
  264. data/lib/dropbox-sign/models/team_get_info_response.rb +19 -3
  265. data/lib/dropbox-sign/models/team_get_response.rb +19 -3
  266. data/lib/dropbox-sign/models/team_info_response.rb +9 -3
  267. data/lib/dropbox-sign/models/team_invite_response.rb +9 -3
  268. data/lib/dropbox-sign/models/team_invites_response.rb +19 -3
  269. data/lib/dropbox-sign/models/team_member_response.rb +9 -3
  270. data/lib/dropbox-sign/models/team_members_response.rb +29 -3
  271. data/lib/dropbox-sign/models/team_parent_response.rb +9 -3
  272. data/lib/dropbox-sign/models/team_remove_member_request.rb +9 -3
  273. data/lib/dropbox-sign/models/team_response.rb +9 -3
  274. data/lib/dropbox-sign/models/team_sub_teams_response.rb +29 -3
  275. data/lib/dropbox-sign/models/team_update_request.rb +9 -3
  276. data/lib/dropbox-sign/models/template_add_user_request.rb +9 -3
  277. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +19 -3
  278. data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +19 -3
  279. data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +9 -3
  280. data/lib/dropbox-sign/models/template_create_request.rb +29 -3
  281. data/lib/dropbox-sign/models/template_create_response.rb +19 -3
  282. data/lib/dropbox-sign/models/template_create_response_template.rb +9 -3
  283. data/lib/dropbox-sign/models/template_edit_response.rb +19 -3
  284. data/lib/dropbox-sign/models/template_get_response.rb +19 -3
  285. data/lib/dropbox-sign/models/template_list_response.rb +29 -3
  286. data/lib/dropbox-sign/models/template_remove_user_request.rb +9 -3
  287. data/lib/dropbox-sign/models/template_response.rb +9 -3
  288. data/lib/dropbox-sign/models/template_response_account.rb +9 -3
  289. data/lib/dropbox-sign/models/template_response_account_quota.rb +9 -3
  290. data/lib/dropbox-sign/models/template_response_cc_role.rb +9 -3
  291. data/lib/dropbox-sign/models/template_response_document.rb +9 -3
  292. data/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +19 -3
  293. data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +19 -3
  294. data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +19 -3
  295. data/lib/dropbox-sign/models/template_response_document_field_group.rb +9 -3
  296. data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +9 -3
  297. data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +19 -3
  298. data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +19 -3
  299. data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +19 -3
  300. data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +19 -3
  301. data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +19 -3
  302. data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +19 -3
  303. data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +29 -3
  304. data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +19 -3
  305. data/lib/dropbox-sign/models/template_response_document_form_field_text.rb +19 -3
  306. data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +19 -3
  307. data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +19 -3
  308. data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +19 -3
  309. data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +19 -3
  310. data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +19 -3
  311. data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +19 -3
  312. data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +19 -3
  313. data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +19 -3
  314. data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +19 -3
  315. data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +9 -3
  316. data/lib/dropbox-sign/models/template_response_signer_role.rb +9 -3
  317. data/lib/dropbox-sign/models/template_update_files_request.rb +9 -3
  318. data/lib/dropbox-sign/models/template_update_files_response.rb +19 -3
  319. data/lib/dropbox-sign/models/template_update_files_response_template.rb +9 -3
  320. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +29 -3
  321. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +39 -3
  322. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +9 -3
  323. data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +19 -3
  324. data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +19 -3
  325. data/lib/dropbox-sign/models/unclaimed_draft_response.rb +9 -3
  326. data/lib/dropbox-sign/models/warning_response.rb +29 -3
  327. data/lib/dropbox-sign/version.rb +2 -2
  328. data/lib/dropbox-sign.rb +5 -1
  329. data/openapi-config.yaml +4 -1
  330. data/openapi-sdk.yaml +3332 -2700
  331. data/run-build +1 -1
  332. data/spec/spec_helper.rb +1 -1
  333. data/templates/README.mustache +2 -2
  334. data/templates/api_client_typhoeus_partial.mustache +7 -8
  335. data/templates/api_doc.mustache +2 -2
  336. data/templates/configuration.mustache +1 -1
  337. data/templates/partial_model_generic.mustache +28 -6
  338. metadata +109 -82
  339. data/examples/AccountCreate.rb +0 -21
  340. data/examples/AccountGet.rb +0 -18
  341. data/examples/AccountUpdate.rb +0 -21
  342. data/examples/AccountVerify.rb +0 -21
  343. data/examples/ApiAppCreate.rb +0 -35
  344. data/examples/ApiAppDelete.rb +0 -20
  345. data/examples/ApiAppGet.rb +0 -20
  346. data/examples/ApiAppList.rb +0 -21
  347. data/examples/ApiAppUpdate.rb +0 -32
  348. data/examples/BulkSendJobGet.rb +0 -20
  349. data/examples/BulkSendJobList.rb +0 -21
  350. data/examples/EmbeddedEditUrl.rb +0 -24
  351. data/examples/EmbeddedSignUrl.rb +0 -20
  352. data/examples/FaxDelete.rb +0 -14
  353. data/examples/FaxFiles.rb +0 -17
  354. data/examples/FaxGet.rb +0 -17
  355. data/examples/FaxLineAddUser.rb +0 -19
  356. data/examples/FaxLineAreaCodeGet.rb +0 -15
  357. data/examples/FaxLineCreate.rb +0 -19
  358. data/examples/FaxLineDelete.rb +0 -17
  359. data/examples/FaxLineGet.rb +0 -15
  360. data/examples/FaxLineList.rb +0 -15
  361. data/examples/FaxLineRemoveUser.rb +0 -19
  362. data/examples/FaxList.rb +0 -18
  363. data/examples/FaxSend.rb +0 -25
  364. data/examples/OauthTokenGenerate.rb +0 -16
  365. data/examples/OauthTokenRefresh.rb +0 -13
  366. data/examples/ReportCreate.rb +0 -23
  367. data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +0 -59
  368. data/examples/SignatureRequestBulkSendWithTemplate.rb +0 -58
  369. data/examples/SignatureRequestCancel.rb +0 -20
  370. data/examples/SignatureRequestCreateEmbedded.rb +0 -46
  371. data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +0 -39
  372. data/examples/SignatureRequestEdit.rb +0 -58
  373. data/examples/SignatureRequestEditEmbedded.rb +0 -48
  374. data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +0 -41
  375. data/examples/SignatureRequestEditWithTemplate.rb +0 -52
  376. data/examples/SignatureRequestFiles.rb +0 -20
  377. data/examples/SignatureRequestFilesAsDataUri.rb +0 -20
  378. data/examples/SignatureRequestFilesAsFileUrl.rb +0 -20
  379. data/examples/SignatureRequestGet.rb +0 -20
  380. data/examples/SignatureRequestList.rb +0 -21
  381. data/examples/SignatureRequestReleaseHold.rb +0 -20
  382. data/examples/SignatureRequestRemind.rb +0 -23
  383. data/examples/SignatureRequestRemove.rb +0 -20
  384. data/examples/SignatureRequestSend.rb +0 -56
  385. data/examples/SignatureRequestSendWithTemplate.rb +0 -50
  386. data/examples/SignatureRequestUpdate.rb +0 -24
  387. data/examples/TeamAddMember.rb +0 -21
  388. data/examples/TeamCreate.rb +0 -21
  389. data/examples/TeamDelete.rb +0 -18
  390. data/examples/TeamGet.rb +0 -18
  391. data/examples/TeamInfo.rb +0 -18
  392. data/examples/TeamInvites.rb +0 -20
  393. data/examples/TeamMembers.rb +0 -20
  394. data/examples/TeamRemoveMember.rb +0 -22
  395. data/examples/TeamSubTeams.rb +0 -20
  396. data/examples/TeamUpdate.rb +0 -21
  397. data/examples/TemplateAddUser.rb +0 -23
  398. data/examples/TemplateCreate.rb +0 -49
  399. data/examples/TemplateCreateEmbeddedDraft.rb +0 -49
  400. data/examples/TemplateDelete.rb +0 -20
  401. data/examples/TemplateFiles.rb +0 -20
  402. data/examples/TemplateFilesAsDataUri.rb +0 -20
  403. data/examples/TemplateFilesAsFileUrl.rb +0 -20
  404. data/examples/TemplateGet.rb +0 -20
  405. data/examples/TemplateList.rb +0 -20
  406. data/examples/TemplateRemoveUser.rb +0 -23
  407. data/examples/TemplateUpdateFiles.rb +0 -23
  408. data/examples/UnclaimedDraftCreate.rb +0 -56
  409. data/examples/UnclaimedDraftCreateEmbedded.rb +0 -24
  410. data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +0 -35
  411. data/examples/UnclaimedDraftEditAndResend.rb +0 -24
  412. /data/examples/{EventCallback.rb → EventCallbackExample.rb} +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0e64c9f5e87bb51e133c06c546b9eb4747739867caf0cd4e062d74a17e052762
4
- data.tar.gz: f698e9b93152e1cbee38194acb69b64d64697a7d93fa9dc72b3cc45cf58ec2cd
3
+ metadata.gz: 115c9d8caa2cbbd35d962c9c999ba123abe4aea2834a1591bd432e506e76ea94
4
+ data.tar.gz: 437feb3ffb253b6a3c224197661baa9080f91af90fa8c9e47992549153a58d98
5
5
  SHA512:
6
- metadata.gz: ef5f4840f660e312d30b0b6d6bc27c36341fc37ae675a63856a374bc3deb28f21ddc8fa79f72b9e41997d23ceefe73e1b0cd763070a95f7f9fc9e2c31ac5587d
7
- data.tar.gz: 69e9db06937df1c18f78246c5e8a180da82ac20865a1c4658868e8d6dc50c8276f64d60b588402d88cd1d05876b256cfa1be1035ac6fbe6774faa415f516ca7a
6
+ metadata.gz: 65935bca72c6fcd9457ed16093c9f828f8fda553b9aa3bec6faf5aac46c0cf8f6ed663604ef8e64f6192ce8896cf5fe4d69d8bdae8b7a8fdd55b49f382838856
7
+ data.tar.gz: 1797fc51ff43717689c1ac92822facccaaf60b73eb13dc84bf8a3c9790d51dcd667b7da3c3d7e3ed5314496aa9501a2e9dc325bf629dc152eb4b5d9212ab3da1
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- dropbox-sign (1.8.0)
4
+ dropbox-sign (1.9.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -13,10 +13,10 @@ GEM
13
13
  diff-lcs (1.5.1)
14
14
  ethon (0.16.0)
15
15
  ffi (>= 1.15.0)
16
- ffi (1.17.0-aarch64-linux-gnu)
17
- ffi (1.17.0-arm64-darwin)
18
- ffi (1.17.0-x86_64-darwin)
19
- ffi (1.17.0-x86_64-linux-gnu)
16
+ ffi (1.17.2-aarch64-linux-gnu)
17
+ ffi (1.17.2-arm64-darwin)
18
+ ffi (1.17.2-x86_64-darwin)
19
+ ffi (1.17.2-x86_64-linux-gnu)
20
20
  json (2.7.2)
21
21
  json_spec (1.1.5)
22
22
  multi_json (~> 1.0)
data/README.md CHANGED
@@ -25,8 +25,8 @@ directory that corresponds to the file you want updated.
25
25
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
26
26
 
27
27
  - API version: 3.0.0
28
- - Package version: 1.8.0
29
- - Generator version: 7.8.0
28
+ - Package version: 1.9.0
29
+ - Generator version: 7.12.0
30
30
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
31
31
 
32
32
  ## Installation
@@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec
47
47
  Then install the gem locally:
48
48
 
49
49
  ```shell
50
- gem install ./dropbox-sign-1.8.0.gem
50
+ gem install ./dropbox-sign-1.9.0.gem
51
51
  ```
52
52
 
53
- (for development, run `gem install --dev ./dropbox-sign-1.8.0.gem` to install the development dependencies)
53
+ (for development, run `gem install --dev ./dropbox-sign-1.9.0.gem` to install the development dependencies)
54
54
 
55
55
 
56
56
  Finally add this to the Gemfile:
57
57
 
58
- gem 'dropbox-sign', '~> 1.8.0'
58
+ gem 'dropbox-sign', '~> 1.9.0'
59
59
 
60
60
  ### Install from Git
61
61
 
@@ -77,26 +77,25 @@ Please follow the [installation](#installation) procedure and then run the follo
77
77
 
78
78
 
79
79
  ```ruby
80
+ require "json"
80
81
  require "dropbox-sign"
81
82
 
82
83
  Dropbox::Sign.configure do |config|
83
- # Configure HTTP basic authorization: api_key
84
84
  config.username = "YOUR_API_KEY"
85
-
86
- # or, configure Bearer (JWT) authorization: oauth2
87
85
  # config.access_token = "YOUR_ACCESS_TOKEN"
88
86
  end
89
87
 
90
- account_api = Dropbox::Sign::AccountApi.new
91
-
92
- data = Dropbox::Sign::AccountCreateRequest.new
93
- data.email_address = "newuser@dropboxsign.com"
88
+ account_create_request = Dropbox::Sign::AccountCreateRequest.new
89
+ account_create_request.email_address = "newuser@dropboxsign.com"
94
90
 
95
91
  begin
96
- result = account_api.account_create(data)
97
- p result
92
+ response = Dropbox::Sign::AccountApi.new.account_create(
93
+ account_create_request,
94
+ )
95
+
96
+ p response
98
97
  rescue Dropbox::Sign::ApiError => e
99
- puts "Exception when calling Dropbox Sign API: #{e}"
98
+ puts "Exception when calling AccountApi#account_create: #{e}"
100
99
  end
101
100
 
102
101
  ```
@@ -122,7 +121,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
122
121
  |*Dropbox::Sign::EmbeddedApi* | [**embedded_edit_url**](docs/EmbeddedApi.md#embedded_edit_url) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL |
123
122
  |*Dropbox::Sign::EmbeddedApi* | [**embedded_sign_url**](docs/EmbeddedApi.md#embedded_sign_url) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL |
124
123
  |*Dropbox::Sign::FaxApi* | [**fax_delete**](docs/FaxApi.md#fax_delete) | **DELETE** /fax/{fax_id} | Delete Fax |
125
- |*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | List Fax Files |
124
+ |*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | Download Fax Files |
126
125
  |*Dropbox::Sign::FaxApi* | [**fax_get**](docs/FaxApi.md#fax_get) | **GET** /fax/{fax_id} | Get Fax |
127
126
  |*Dropbox::Sign::FaxApi* | [**fax_list**](docs/FaxApi.md#fax_list) | **GET** /fax/list | Lists Faxes |
128
127
  |*Dropbox::Sign::FaxApi* | [**fax_send**](docs/FaxApi.md#fax_send) | **POST** /fax/send | Send Fax |
@@ -141,6 +140,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
141
140
  |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_cancel**](docs/SignatureRequestApi.md#signature_request_cancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request |
142
141
  |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_create_embedded**](docs/SignatureRequestApi.md#signature_request_create_embedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request |
143
142
  |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_create_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template |
143
+ |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit**](docs/SignatureRequestApi.md#signature_request_edit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request |
144
+ |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_embedded**](docs/SignatureRequestApi.md#signature_request_edit_embedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request |
145
+ |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_edit_embedded_with_template) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template |
146
+ |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_with_template**](docs/SignatureRequestApi.md#signature_request_edit_with_template) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template |
144
147
  |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files**](docs/SignatureRequestApi.md#signature_request_files) | **GET** /signature_request/files/{signature_request_id} | Download Files |
145
148
  |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files_as_data_uri**](docs/SignatureRequestApi.md#signature_request_files_as_data_uri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri |
146
149
  |*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files_as_file_url**](docs/SignatureRequestApi.md#signature_request_files_as_file_url) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url |
@@ -244,6 +247,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
244
247
  - [Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md)
245
248
  - [Dropbox::Sign::SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md)
246
249
  - [Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md)
250
+ - [Dropbox::Sign::SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md)
251
+ - [Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md)
252
+ - [Dropbox::Sign::SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md)
253
+ - [Dropbox::Sign::SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md)
247
254
  - [Dropbox::Sign::SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md)
248
255
  - [Dropbox::Sign::SignatureRequestListResponse](docs/SignatureRequestListResponse.md)
249
256
  - [Dropbox::Sign::SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md)
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.8.0
1
+ 1.9.0
data/docs/AccountApi.md CHANGED
@@ -21,26 +21,25 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_
21
21
  ### Examples
22
22
 
23
23
  ```ruby
24
+ require "json"
24
25
  require "dropbox-sign"
25
26
 
26
27
  Dropbox::Sign.configure do |config|
27
- # Configure HTTP basic authorization: api_key
28
28
  config.username = "YOUR_API_KEY"
29
-
30
- # or, configure Bearer (JWT) authorization: oauth2
31
29
  # config.access_token = "YOUR_ACCESS_TOKEN"
32
30
  end
33
31
 
34
- account_api = Dropbox::Sign::AccountApi.new
35
-
36
- data = Dropbox::Sign::AccountCreateRequest.new
37
- data.email_address = "newuser@dropboxsign.com"
32
+ account_create_request = Dropbox::Sign::AccountCreateRequest.new
33
+ account_create_request.email_address = "newuser@dropboxsign.com"
38
34
 
39
35
  begin
40
- result = account_api.account_create(data)
41
- p result
36
+ response = Dropbox::Sign::AccountApi.new.account_create(
37
+ account_create_request,
38
+ )
39
+
40
+ p response
42
41
  rescue Dropbox::Sign::ApiError => e
43
- puts "Exception when calling Dropbox Sign API: #{e}"
42
+ puts "Exception when calling AccountApi#account_create: #{e}"
44
43
  end
45
44
 
46
45
  ```
@@ -94,23 +93,20 @@ Returns the properties and settings of your Account.
94
93
  ### Examples
95
94
 
96
95
  ```ruby
96
+ require "json"
97
97
  require "dropbox-sign"
98
98
 
99
99
  Dropbox::Sign.configure do |config|
100
- # Configure HTTP basic authorization: api_key
101
100
  config.username = "YOUR_API_KEY"
102
-
103
- # or, configure Bearer (JWT) authorization: oauth2
104
101
  # config.access_token = "YOUR_ACCESS_TOKEN"
105
102
  end
106
103
 
107
- account_api = Dropbox::Sign::AccountApi.new
108
-
109
104
  begin
110
- result = account_api.account_get({ email_address: "jack@example.com" })
111
- p result
105
+ response = Dropbox::Sign::AccountApi.new.account_get
106
+
107
+ p response
112
108
  rescue Dropbox::Sign::ApiError => e
113
- puts "Exception when calling Dropbox Sign API: #{e}"
109
+ puts "Exception when calling AccountApi#account_get: #{e}"
114
110
  end
115
111
 
116
112
  ```
@@ -165,26 +161,26 @@ Updates the properties and settings of your Account. Currently only allows for u
165
161
  ### Examples
166
162
 
167
163
  ```ruby
164
+ require "json"
168
165
  require "dropbox-sign"
169
166
 
170
167
  Dropbox::Sign.configure do |config|
171
- # Configure HTTP basic authorization: api_key
172
168
  config.username = "YOUR_API_KEY"
173
-
174
- # or, configure Bearer (JWT) authorization: oauth2
175
169
  # config.access_token = "YOUR_ACCESS_TOKEN"
176
170
  end
177
171
 
178
- account_api = Dropbox::Sign::AccountApi.new
179
-
180
- data = Dropbox::Sign::AccountUpdateRequest.new
181
- data.callback_url = "https://www.example.com/callback"
172
+ account_update_request = Dropbox::Sign::AccountUpdateRequest.new
173
+ account_update_request.callback_url = "https://www.example.com/callback"
174
+ account_update_request.locale = "en-US"
182
175
 
183
176
  begin
184
- result = account_api.account_update(data)
185
- p result
177
+ response = Dropbox::Sign::AccountApi.new.account_update(
178
+ account_update_request,
179
+ )
180
+
181
+ p response
186
182
  rescue Dropbox::Sign::ApiError => e
187
- puts "Exception when calling Dropbox Sign API: #{e}"
183
+ puts "Exception when calling AccountApi#account_update: #{e}"
188
184
  end
189
185
 
190
186
  ```
@@ -238,26 +234,25 @@ Verifies whether an Dropbox Sign Account exists for the given email address.
238
234
  ### Examples
239
235
 
240
236
  ```ruby
237
+ require "json"
241
238
  require "dropbox-sign"
242
239
 
243
240
  Dropbox::Sign.configure do |config|
244
- # Configure HTTP basic authorization: api_key
245
241
  config.username = "YOUR_API_KEY"
246
-
247
- # or, configure Bearer (JWT) authorization: oauth2
248
242
  # config.access_token = "YOUR_ACCESS_TOKEN"
249
243
  end
250
244
 
251
- account_api = Dropbox::Sign::AccountApi.new
252
-
253
- data = Dropbox::Sign::AccountVerifyRequest.new
254
- data.email_address = "some_user@dropboxsign.com"
245
+ account_verify_request = Dropbox::Sign::AccountVerifyRequest.new
246
+ account_verify_request.email_address = "some_user@dropboxsign.com"
255
247
 
256
248
  begin
257
- result = account_api.account_verify(data)
258
- p result
249
+ response = Dropbox::Sign::AccountApi.new.account_verify(
250
+ account_verify_request,
251
+ )
252
+
253
+ p response
259
254
  rescue Dropbox::Sign::ApiError => e
260
- puts "Exception when calling Dropbox Sign API: #{e}"
255
+ puts "Exception when calling AccountApi#account_verify: #{e}"
261
256
  end
262
257
 
263
258
  ```
data/docs/ApiAppApi.md CHANGED
@@ -22,40 +22,42 @@ Creates a new API App.
22
22
  ### Examples
23
23
 
24
24
  ```ruby
25
+ require "json"
25
26
  require "dropbox-sign"
26
27
 
27
28
  Dropbox::Sign.configure do |config|
28
- # Configure HTTP basic authorization: api_key
29
29
  config.username = "YOUR_API_KEY"
30
-
31
- # or, configure Bearer (JWT) authorization: oauth2
32
30
  # config.access_token = "YOUR_ACCESS_TOKEN"
33
31
  end
34
32
 
35
- api_app_api = Dropbox::Sign::ApiAppApi.new
36
-
37
33
  oauth = Dropbox::Sign::SubOAuth.new
38
34
  oauth.callback_url = "https://example.com/oauth"
39
- oauth.scopes = %w[basic_account_info request_signature]
35
+ oauth.scopes = [
36
+ "basic_account_info",
37
+ "request_signature",
38
+ ]
40
39
 
41
40
  white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new
42
41
  white_labeling_options.primary_button_color = "#00b3e6"
43
42
  white_labeling_options.primary_button_text_color = "#ffffff"
44
43
 
45
- custom_logo_file = File.new('./CustomLogoFile.png')
46
-
47
- data = Dropbox::Sign::ApiAppCreateRequest.new
48
- data.name = "My Production App"
49
- data.domains = ["example.com"]
50
- data.oauth = oauth
51
- data.white_labeling_options = white_labeling_options
52
- data.custom_logo_file = custom_logo_file
44
+ api_app_create_request = Dropbox::Sign::ApiAppCreateRequest.new
45
+ api_app_create_request.name = "My Production App"
46
+ api_app_create_request.domains = [
47
+ "example.com",
48
+ ]
49
+ api_app_create_request.custom_logo_file = File.new("CustomLogoFile.png", "r")
50
+ api_app_create_request.oauth = oauth
51
+ api_app_create_request.white_labeling_options = white_labeling_options
53
52
 
54
53
  begin
55
- result = api_app_api.api_app_create(data)
56
- p result
54
+ response = Dropbox::Sign::ApiAppApi.new.api_app_create(
55
+ api_app_create_request,
56
+ )
57
+
58
+ p response
57
59
  rescue Dropbox::Sign::ApiError => e
58
- puts "Exception when calling Dropbox Sign API: #{e}"
60
+ puts "Exception when calling ApiAppApi#api_app_create: #{e}"
59
61
  end
60
62
 
61
63
  ```
@@ -109,25 +111,20 @@ Deletes an API App. Can only be invoked for apps you own.
109
111
  ### Examples
110
112
 
111
113
  ```ruby
114
+ require "json"
112
115
  require "dropbox-sign"
113
116
 
114
117
  Dropbox::Sign.configure do |config|
115
- # Configure HTTP basic authorization: api_key
116
118
  config.username = "YOUR_API_KEY"
117
-
118
- # or, configure Bearer (JWT) authorization: oauth2
119
119
  # config.access_token = "YOUR_ACCESS_TOKEN"
120
120
  end
121
121
 
122
- api_app_api = Dropbox::Sign::ApiAppApi.new
123
-
124
- client_id = "0dd3b823a682527788c4e40cb7b6f7e9"
125
-
126
122
  begin
127
- result = api_app_api.api_app_delete(client_id)
128
- p result
123
+ Dropbox::Sign::ApiAppApi.new.api_app_delete(
124
+ "0dd3b823a682527788c4e40cb7b6f7e9", # client_id
125
+ )
129
126
  rescue Dropbox::Sign::ApiError => e
130
- puts "Exception when calling Dropbox Sign API: #{e}"
127
+ puts "Exception when calling ApiAppApi#api_app_delete: #{e}"
131
128
  end
132
129
 
133
130
  ```
@@ -181,25 +178,22 @@ Returns an object with information about an API App.
181
178
  ### Examples
182
179
 
183
180
  ```ruby
181
+ require "json"
184
182
  require "dropbox-sign"
185
183
 
186
184
  Dropbox::Sign.configure do |config|
187
- # Configure HTTP basic authorization: api_key
188
185
  config.username = "YOUR_API_KEY"
189
-
190
- # or, configure Bearer (JWT) authorization: oauth2
191
186
  # config.access_token = "YOUR_ACCESS_TOKEN"
192
187
  end
193
188
 
194
- api_app_api = Dropbox::Sign::ApiAppApi.new
195
-
196
- client_id = "0dd3b823a682527788c4e40cb7b6f7e9"
197
-
198
189
  begin
199
- result = api_app_api.api_app_get(client_id)
200
- p result
190
+ response = Dropbox::Sign::ApiAppApi.new.api_app_get(
191
+ "0dd3b823a682527788c4e40cb7b6f7e9", # client_id
192
+ )
193
+
194
+ p response
201
195
  rescue Dropbox::Sign::ApiError => e
202
- puts "Exception when calling Dropbox Sign API: #{e}"
196
+ puts "Exception when calling ApiAppApi#api_app_get: #{e}"
203
197
  end
204
198
 
205
199
  ```
@@ -253,26 +247,25 @@ Returns a list of API Apps that are accessible by you. If you are on a team with
253
247
  ### Examples
254
248
 
255
249
  ```ruby
250
+ require "json"
256
251
  require "dropbox-sign"
257
252
 
258
253
  Dropbox::Sign.configure do |config|
259
- # Configure HTTP basic authorization: api_key
260
254
  config.username = "YOUR_API_KEY"
261
-
262
- # or, configure Bearer (JWT) authorization: oauth2
263
255
  # config.access_token = "YOUR_ACCESS_TOKEN"
264
256
  end
265
257
 
266
- api_app_api = Dropbox::Sign::ApiAppApi.new
267
-
268
- page = 1
269
- page_size = 2
270
-
271
258
  begin
272
- result = api_app_api.api_app_list({ page: page, page_size: page_size })
273
- p result
259
+ response = Dropbox::Sign::ApiAppApi.new.api_app_list(
260
+ {
261
+ page: 1,
262
+ page_size: 20,
263
+ },
264
+ )
265
+
266
+ p response
274
267
  rescue Dropbox::Sign::ApiError => e
275
- puts "Exception when calling Dropbox Sign API: #{e}"
268
+ puts "Exception when calling ApiAppApi#api_app_list: #{e}"
276
269
  end
277
270
 
278
271
  ```
@@ -327,37 +320,44 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel
327
320
  ### Examples
328
321
 
329
322
  ```ruby
323
+ require "json"
330
324
  require "dropbox-sign"
331
325
 
332
326
  Dropbox::Sign.configure do |config|
333
- # Configure HTTP basic authorization: api_key
334
327
  config.username = "YOUR_API_KEY"
335
-
336
- # or, configure Bearer (JWT) authorization: oauth2
337
328
  # config.access_token = "YOUR_ACCESS_TOKEN"
338
329
  end
339
330
 
340
- api_app_api = Dropbox::Sign::ApiAppApi.new
331
+ oauth = Dropbox::Sign::SubOAuth.new
332
+ oauth.callback_url = "https://example.com/oauth"
333
+ oauth.scopes = [
334
+ "basic_account_info",
335
+ "request_signature",
336
+ ]
341
337
 
342
338
  white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new
343
339
  white_labeling_options.primary_button_color = "#00b3e6"
344
340
  white_labeling_options.primary_button_text_color = "#ffffff"
345
341
 
346
- custom_logo_file = File.new('./CustomLogoFile.png')
347
-
348
- data = Dropbox::Sign::ApiAppUpdateRequest.new
349
- data.name = "New Name"
350
- data.callback_url = "http://example.com/dropboxsign"
351
- data.white_labeling_options = white_labeling_options
352
- data.custom_logo_file = custom_logo_file
353
-
354
- client_id = "0dd3b823a682527788c4e40cb7b6f7e9"
342
+ api_app_update_request = Dropbox::Sign::ApiAppUpdateRequest.new
343
+ api_app_update_request.callback_url = "https://example.com/dropboxsign"
344
+ api_app_update_request.name = "New Name"
345
+ api_app_update_request.domains = [
346
+ "example.com",
347
+ ]
348
+ api_app_update_request.custom_logo_file = File.new("CustomLogoFile.png", "r")
349
+ api_app_update_request.oauth = oauth
350
+ api_app_update_request.white_labeling_options = white_labeling_options
355
351
 
356
352
  begin
357
- result = api_app_api.api_app_update(client_id, data)
358
- p result
353
+ response = Dropbox::Sign::ApiAppApi.new.api_app_update(
354
+ "0dd3b823a682527788c4e40cb7b6f7e9", # client_id
355
+ api_app_update_request,
356
+ )
357
+
358
+ p response
359
359
  rescue Dropbox::Sign::ApiError => e
360
- puts "Exception when calling Dropbox Sign API: #{e}"
360
+ puts "Exception when calling ApiAppApi#api_app_update: #{e}"
361
361
  end
362
362
 
363
363
  ```
@@ -19,25 +19,26 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the
19
19
  ### Examples
20
20
 
21
21
  ```ruby
22
+ require "json"
22
23
  require "dropbox-sign"
23
24
 
24
25
  Dropbox::Sign.configure do |config|
25
- # Configure HTTP basic authorization: api_key
26
26
  config.username = "YOUR_API_KEY"
27
-
28
- # or, configure Bearer (JWT) authorization: oauth2
29
27
  # config.access_token = "YOUR_ACCESS_TOKEN"
30
28
  end
31
29
 
32
- bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new
33
-
34
- bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"
35
-
36
30
  begin
37
- result = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id)
38
- p result
31
+ response = Dropbox::Sign::BulkSendJobApi.new.bulk_send_job_get(
32
+ "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", # bulk_send_job_id
33
+ {
34
+ page: 1,
35
+ page_size: 20,
36
+ },
37
+ )
38
+
39
+ p response
39
40
  rescue Dropbox::Sign::ApiError => e
40
- puts "Exception when calling Dropbox Sign API: #{e}"
41
+ puts "Exception when calling BulkSendJobApi#bulk_send_job_get: #{e}"
41
42
  end
42
43
 
43
44
  ```
@@ -93,26 +94,25 @@ Returns a list of BulkSendJob that you can access.
93
94
  ### Examples
94
95
 
95
96
  ```ruby
97
+ require "json"
96
98
  require "dropbox-sign"
97
99
 
98
100
  Dropbox::Sign.configure do |config|
99
- # Configure HTTP basic authorization: api_key
100
101
  config.username = "YOUR_API_KEY"
101
-
102
- # or, configure Bearer (JWT) authorization: oauth2
103
102
  # config.access_token = "YOUR_ACCESS_TOKEN"
104
103
  end
105
104
 
106
- bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new
107
-
108
- page = 1
109
- page_size = 20
110
-
111
105
  begin
112
- result = bulk_send_job_api.bulk_send_job_list({ page: page, page_size: page_size })
113
- p result
106
+ response = Dropbox::Sign::BulkSendJobApi.new.bulk_send_job_list(
107
+ {
108
+ page: 1,
109
+ page_size: 20,
110
+ },
111
+ )
112
+
113
+ p response
114
114
  rescue Dropbox::Sign::ApiError => e
115
- puts "Exception when calling Dropbox Sign API: #{e}"
115
+ puts "Exception when calling BulkSendJobApi#bulk_send_job_list: #{e}"
116
116
  end
117
117
 
118
118
  ```
data/docs/EmbeddedApi.md CHANGED
@@ -19,29 +19,32 @@ Retrieves an embedded object containing a template url that can be opened in an
19
19
  ### Examples
20
20
 
21
21
  ```ruby
22
+ require "json"
22
23
  require "dropbox-sign"
23
24
 
24
25
  Dropbox::Sign.configure do |config|
25
- # Configure HTTP basic authorization: api_key
26
26
  config.username = "YOUR_API_KEY"
27
-
28
- # or, configure Bearer (JWT) authorization: oauth2
29
27
  # config.access_token = "YOUR_ACCESS_TOKEN"
30
28
  end
31
29
 
32
- api = Dropbox::Sign::EmbeddedApi.new
33
-
34
- data = Dropbox::Sign::EmbeddedEditUrlRequest.new
35
- data.cc_roles = [""]
36
- data.merge_fields = []
30
+ merge_fields = [
31
+ ]
37
32
 
38
- template_id = "5de8179668f2033afac48da1868d0093bf133266"
33
+ embedded_edit_url_request = Dropbox::Sign::EmbeddedEditUrlRequest.new
34
+ embedded_edit_url_request.cc_roles = [
35
+ "",
36
+ ]
37
+ embedded_edit_url_request.merge_fields = merge_fields
39
38
 
40
39
  begin
41
- result = embedded_api.embedded_edit_url(template_id, data)
42
- p result
40
+ response = Dropbox::Sign::EmbeddedApi.new.embedded_edit_url(
41
+ "f57db65d3f933b5316d398057a36176831451a35", # template_id
42
+ embedded_edit_url_request,
43
+ )
44
+
45
+ p response
43
46
  rescue Dropbox::Sign::ApiError => e
44
- puts "Exception when calling Dropbox Sign API: #{e}"
47
+ puts "Exception when calling EmbeddedApi#embedded_edit_url: #{e}"
45
48
  end
46
49
 
47
50
  ```
@@ -96,25 +99,22 @@ Retrieves an embedded object containing a signature url that can be opened in an
96
99
  ### Examples
97
100
 
98
101
  ```ruby
102
+ require "json"
99
103
  require "dropbox-sign"
100
104
 
101
105
  Dropbox::Sign.configure do |config|
102
- # Configure HTTP basic authorization: api_key
103
106
  config.username = "YOUR_API_KEY"
104
-
105
- # or, configure Bearer (JWT) authorization: oauth2
106
107
  # config.access_token = "YOUR_ACCESS_TOKEN"
107
108
  end
108
109
 
109
- api = Dropbox::Sign::EmbeddedApi.new
110
-
111
- signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"
112
-
113
110
  begin
114
- result = embedded_api.embedded_sign_url(signature_id)
115
- p result
111
+ response = Dropbox::Sign::EmbeddedApi.new.embedded_sign_url(
112
+ "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", # signature_id
113
+ )
114
+
115
+ p response
116
116
  rescue Dropbox::Sign::ApiError => e
117
- puts "Exception when calling Dropbox Sign API: #{e}"
117
+ puts "Exception when calling EmbeddedApi#embedded_sign_url: #{e}"
118
118
  end
119
119
 
120
120
  ```