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,782 @@
1
+ # Dropbox::Sign::TemplateApi
2
+
3
+ All URIs are relative to *https://api.hellosign.com/v3*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [`template_add_user`](TemplateApi.md#template_add_user) | **POST** `/template/add_user/{template_id}` | Add User to Template |
8
+ | [`template_create_embedded_draft`](TemplateApi.md#template_create_embedded_draft) | **POST** `/template/create_embedded_draft` | Create Embedded Template Draft |
9
+ | [`template_delete`](TemplateApi.md#template_delete) | **POST** `/template/delete/{template_id}` | Delete Template |
10
+ | [`template_files`](TemplateApi.md#template_files) | **GET** `/template/files/{template_id}` | Get Template Files |
11
+ | [`template_files_as_data_uri`](TemplateApi.md#template_files_as_data_uri) | **GET** `/template/files_as_data_uri/{template_id}` | Get Template Files as Data Uri |
12
+ | [`template_files_as_file_url`](TemplateApi.md#template_files_as_file_url) | **GET** `/template/files_as_file_url/{template_id}` | Get Template Files as File Url |
13
+ | [`template_get`](TemplateApi.md#template_get) | **GET** `/template/{template_id}` | Get Template |
14
+ | [`template_list`](TemplateApi.md#template_list) | **GET** `/template/list` | List Templates |
15
+ | [`template_remove_user`](TemplateApi.md#template_remove_user) | **POST** `/template/remove_user/{template_id}` | Remove User from Template |
16
+ | [`template_update_files`](TemplateApi.md#template_update_files) | **POST** `/template/update_files/{template_id}` | Update Template Files |
17
+
18
+
19
+ ## `template_add_user`
20
+
21
+ > `<TemplateGetResponse> template_add_user(template_id, template_add_user_request)`
22
+
23
+ Add User to Template
24
+
25
+ Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
26
+
27
+ ### Examples
28
+
29
+ ```ruby
30
+ require "dropbox-sign"
31
+
32
+ Dropbox::Sign.configure do |config|
33
+ # Configure HTTP basic authorization: api_key
34
+ config.username = "YOUR_API_KEY"
35
+
36
+ # or, configure Bearer (JWT) authorization: oauth2
37
+ # config.access_token = "YOUR_ACCESS_TOKEN"
38
+ end
39
+
40
+ template_api = Dropbox::Sign::TemplateApi.new
41
+
42
+ data = Dropbox::Sign::TemplateAddUserRequest.new
43
+ data.email_address = "george@dropboxsign.com"
44
+
45
+ template_id = "f57db65d3f933b5316d398057a36176831451a35"
46
+
47
+ begin
48
+ result = template_api.template_add_user(template_id, data)
49
+ p result
50
+ rescue Dropbox::Sign::ApiError => e
51
+ puts "Exception when calling Dropbox Sign API: #{e}"
52
+ end
53
+
54
+ ```
55
+
56
+ #### Using the `template_add_user_with_http_info` variant
57
+
58
+ This returns an Array which contains the response data, status code and headers.
59
+
60
+ > `<Array(<TemplateGetResponse>, Integer, Hash)> template_add_user_with_http_info(template_id, template_add_user_request)`
61
+
62
+ ```ruby
63
+ begin
64
+ # Add User to Template
65
+ data, status_code, headers = api_instance.template_add_user_with_http_info(template_id, template_add_user_request)
66
+ p status_code # => 2xx
67
+ p headers # => { ... }
68
+ p data # => <TemplateGetResponse>
69
+ rescue Dropbox::Sign::ApiError => e
70
+ puts "Error when calling TemplateApi->template_add_user_with_http_info: #{e}"
71
+ end
72
+ ```
73
+
74
+ ### Parameters
75
+
76
+ | Name | Type | Description | Notes |
77
+ | ---- | ---- | ----------- | ----- |
78
+ | `template_id` | **String** | The id of the Template to give the Account access to. | |
79
+ | `template_add_user_request` | [**TemplateAddUserRequest**](TemplateAddUserRequest.md) | | |
80
+
81
+ ### Return type
82
+
83
+ [**TemplateGetResponse**](TemplateGetResponse.md)
84
+
85
+ ### Authorization
86
+
87
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
88
+
89
+ ### HTTP request headers
90
+
91
+ - **Content-Type**: application/json
92
+ - **Accept**: application/json
93
+
94
+
95
+ ## `template_create_embedded_draft`
96
+
97
+ > `<TemplateCreateEmbeddedDraftResponse> template_create_embedded_draft(template_create_embedded_draft_request)`
98
+
99
+ Create Embedded Template Draft
100
+
101
+ The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
102
+
103
+ ### Examples
104
+
105
+ ```ruby
106
+ require "dropbox-sign"
107
+
108
+ Dropbox::Sign.configure do |config|
109
+ # Configure HTTP basic authorization: api_key
110
+ config.username = "YOUR_API_KEY"
111
+
112
+ # or, configure Bearer (JWT) authorization: oauth2
113
+ # config.access_token = "YOUR_ACCESS_TOKEN"
114
+ end
115
+
116
+ template_api = Dropbox::Sign::TemplateApi.new
117
+
118
+ role_1 = Dropbox::Sign::SubTemplateRole.new
119
+ role_1.name = "Client"
120
+ role_1.order = 0
121
+
122
+ role_2 = Dropbox::Sign::SubTemplateRole.new
123
+ role_2.name = "Witness"
124
+ role_2.order = 1
125
+
126
+ merge_field_1 = Dropbox::Sign::SubMergeField.new
127
+ merge_field_1.name = "Full Name"
128
+ merge_field_1.type = "text"
129
+
130
+ merge_field_2 = Dropbox::Sign::SubMergeField.new
131
+ merge_field_2.name = "Is Registered?"
132
+ merge_field_2.type = "checkbox"
133
+
134
+ field_options = Dropbox::Sign::SubFieldOptions.new
135
+ field_options.date_format = "DD - MM - YYYY"
136
+
137
+ data = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new
138
+ data.client_id = "37dee8d8440c66d54cfa05d92c160882"
139
+ data.files = [File.new("example_signature_request.pdf", "r")]
140
+ data.title = "Test Template"
141
+ data.subject = "Please sign this document"
142
+ data.message = "For your approval"
143
+ data.signer_roles = [role_1, role_2]
144
+ data.cc_roles = ["Manager"]
145
+ data.merge_fields = [merge_field_1, merge_field_2]
146
+ data.field_options = field_options
147
+ data.test_mode = true
148
+
149
+ begin
150
+ result = template_api.template_create_embedded_draft(data)
151
+ p result
152
+ rescue Dropbox::Sign::ApiError => e
153
+ puts "Exception when calling Dropbox Sign API: #{e}"
154
+ end
155
+
156
+ ```
157
+
158
+ #### Using the `template_create_embedded_draft_with_http_info` variant
159
+
160
+ This returns an Array which contains the response data, status code and headers.
161
+
162
+ > `<Array(<TemplateCreateEmbeddedDraftResponse>, Integer, Hash)> template_create_embedded_draft_with_http_info(template_create_embedded_draft_request)`
163
+
164
+ ```ruby
165
+ begin
166
+ # Create Embedded Template Draft
167
+ data, status_code, headers = api_instance.template_create_embedded_draft_with_http_info(template_create_embedded_draft_request)
168
+ p status_code # => 2xx
169
+ p headers # => { ... }
170
+ p data # => <TemplateCreateEmbeddedDraftResponse>
171
+ rescue Dropbox::Sign::ApiError => e
172
+ puts "Error when calling TemplateApi->template_create_embedded_draft_with_http_info: #{e}"
173
+ end
174
+ ```
175
+
176
+ ### Parameters
177
+
178
+ | Name | Type | Description | Notes |
179
+ | ---- | ---- | ----------- | ----- |
180
+ | `template_create_embedded_draft_request` | [**TemplateCreateEmbeddedDraftRequest**](TemplateCreateEmbeddedDraftRequest.md) | | |
181
+
182
+ ### Return type
183
+
184
+ [**TemplateCreateEmbeddedDraftResponse**](TemplateCreateEmbeddedDraftResponse.md)
185
+
186
+ ### Authorization
187
+
188
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
189
+
190
+ ### HTTP request headers
191
+
192
+ - **Content-Type**: application/json, multipart/form-data
193
+ - **Accept**: application/json
194
+
195
+
196
+ ## `template_delete`
197
+
198
+ > `template_delete(template_id)`
199
+
200
+ Delete Template
201
+
202
+ Completely deletes the template specified from the account.
203
+
204
+ ### Examples
205
+
206
+ ```ruby
207
+ require "dropbox-sign"
208
+
209
+ Dropbox::Sign.configure do |config|
210
+ # Configure HTTP basic authorization: api_key
211
+ config.username = "YOUR_API_KEY"
212
+
213
+ # or, configure Bearer (JWT) authorization: oauth2
214
+ # config.access_token = "YOUR_ACCESS_TOKEN"
215
+ end
216
+
217
+ template_api = Dropbox::Sign::TemplateApi.new
218
+
219
+ template_id = "5de8179668f2033afac48da1868d0093bf133266"
220
+
221
+ begin
222
+ result = template_api.template_delete(template_id)
223
+ p result
224
+ rescue Dropbox::Sign::ApiError => e
225
+ puts "Exception when calling Dropbox Sign API: #{e}"
226
+ end
227
+
228
+ ```
229
+
230
+ #### Using the `template_delete_with_http_info` variant
231
+
232
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
233
+
234
+ > `<Array(nil, Integer, Hash)> template_delete_with_http_info(template_id)`
235
+
236
+ ```ruby
237
+ begin
238
+ # Delete Template
239
+ data, status_code, headers = api_instance.template_delete_with_http_info(template_id)
240
+ p status_code # => 2xx
241
+ p headers # => { ... }
242
+ p data # => nil
243
+ rescue Dropbox::Sign::ApiError => e
244
+ puts "Error when calling TemplateApi->template_delete_with_http_info: #{e}"
245
+ end
246
+ ```
247
+
248
+ ### Parameters
249
+
250
+ | Name | Type | Description | Notes |
251
+ | ---- | ---- | ----------- | ----- |
252
+ | `template_id` | **String** | The id of the Template to delete. | |
253
+
254
+ ### Return type
255
+
256
+ nil (empty response body)
257
+
258
+ ### Authorization
259
+
260
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
261
+
262
+ ### HTTP request headers
263
+
264
+ - **Content-Type**: Not defined
265
+ - **Accept**: application/json
266
+
267
+
268
+ ## `template_files`
269
+
270
+ > `File template_files(template_id, opts)`
271
+
272
+ Get Template Files
273
+
274
+ Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
275
+
276
+ ### Examples
277
+
278
+ ```ruby
279
+ require "dropbox-sign"
280
+
281
+ Dropbox::Sign.configure do |config|
282
+ # Configure HTTP basic authorization: api_key
283
+ config.username = "YOUR_API_KEY"
284
+
285
+ # or, configure Bearer (JWT) authorization: oauth2
286
+ # config.access_token = "YOUR_ACCESS_TOKEN"
287
+ end
288
+
289
+ template_api = Dropbox::Sign::TemplateApi.new
290
+
291
+ template_id = "5de8179668f2033afac48da1868d0093bf133266"
292
+
293
+ begin
294
+ file_bin = template_api.template_files(template_id)
295
+ FileUtils.cp(file_bin.path, "path/to/file.pdf")
296
+ rescue Dropbox::Sign::ApiError => e
297
+ puts "Exception when calling Dropbox Sign API: #{e}"
298
+ end
299
+
300
+ ```
301
+
302
+ #### Using the `template_files_with_http_info` variant
303
+
304
+ This returns an Array which contains the response data, status code and headers.
305
+
306
+ > `<Array(File, Integer, Hash)> template_files_with_http_info(template_id, opts)`
307
+
308
+ ```ruby
309
+ begin
310
+ # Get Template Files
311
+ data, status_code, headers = api_instance.template_files_with_http_info(template_id, opts)
312
+ p status_code # => 2xx
313
+ p headers # => { ... }
314
+ p data # => File
315
+ rescue Dropbox::Sign::ApiError => e
316
+ puts "Error when calling TemplateApi->template_files_with_http_info: #{e}"
317
+ end
318
+ ```
319
+
320
+ ### Parameters
321
+
322
+ | Name | Type | Description | Notes |
323
+ | ---- | ---- | ----------- | ----- |
324
+ | `template_id` | **String** | The id of the template files to retrieve. | |
325
+ | `file_type` | **String** | Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] |
326
+
327
+ ### Return type
328
+
329
+ **File**
330
+
331
+ ### Authorization
332
+
333
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
334
+
335
+ ### HTTP request headers
336
+
337
+ - **Content-Type**: Not defined
338
+ - **Accept**: application/pdf, application/zip, application/json
339
+
340
+
341
+ ## `template_files_as_data_uri`
342
+
343
+ > `<FileResponseDataUri> template_files_as_data_uri(template_id)`
344
+
345
+ Get Template Files as Data Uri
346
+
347
+ Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
348
+
349
+ ### Examples
350
+
351
+ ```ruby
352
+ require "dropbox-sign"
353
+
354
+ Dropbox::Sign.configure do |config|
355
+ # Configure HTTP basic authorization: api_key
356
+ config.username = "YOUR_API_KEY"
357
+
358
+ # or, configure Bearer (JWT) authorization: oauth2
359
+ # config.access_token = "YOUR_ACCESS_TOKEN"
360
+ end
361
+
362
+ template_api = Dropbox::Sign::TemplateApi.new
363
+
364
+ template_id = "5de8179668f2033afac48da1868d0093bf133266"
365
+
366
+ begin
367
+ result = template_api.template_files_as_data_uri(template_id)
368
+ p result
369
+ rescue Dropbox::Sign::ApiError => e
370
+ puts "Exception when calling Dropbox Sign API: #{e}"
371
+ end
372
+
373
+ ```
374
+
375
+ #### Using the `template_files_as_data_uri_with_http_info` variant
376
+
377
+ This returns an Array which contains the response data, status code and headers.
378
+
379
+ > `<Array(<FileResponseDataUri>, Integer, Hash)> template_files_as_data_uri_with_http_info(template_id)`
380
+
381
+ ```ruby
382
+ begin
383
+ # Get Template Files as Data Uri
384
+ data, status_code, headers = api_instance.template_files_as_data_uri_with_http_info(template_id)
385
+ p status_code # => 2xx
386
+ p headers # => { ... }
387
+ p data # => <FileResponseDataUri>
388
+ rescue Dropbox::Sign::ApiError => e
389
+ puts "Error when calling TemplateApi->template_files_as_data_uri_with_http_info: #{e}"
390
+ end
391
+ ```
392
+
393
+ ### Parameters
394
+
395
+ | Name | Type | Description | Notes |
396
+ | ---- | ---- | ----------- | ----- |
397
+ | `template_id` | **String** | The id of the template files to retrieve. | |
398
+
399
+ ### Return type
400
+
401
+ [**FileResponseDataUri**](FileResponseDataUri.md)
402
+
403
+ ### Authorization
404
+
405
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
406
+
407
+ ### HTTP request headers
408
+
409
+ - **Content-Type**: Not defined
410
+ - **Accept**: application/json
411
+
412
+
413
+ ## `template_files_as_file_url`
414
+
415
+ > `<FileResponse> template_files_as_file_url(template_id)`
416
+
417
+ Get Template Files as File Url
418
+
419
+ Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
420
+
421
+ ### Examples
422
+
423
+ ```ruby
424
+ require "dropbox-sign"
425
+
426
+ Dropbox::Sign.configure do |config|
427
+ # Configure HTTP basic authorization: api_key
428
+ config.username = "YOUR_API_KEY"
429
+
430
+ # or, configure Bearer (JWT) authorization: oauth2
431
+ # config.access_token = "YOUR_ACCESS_TOKEN"
432
+ end
433
+
434
+ template_api = Dropbox::Sign::TemplateApi.new
435
+
436
+ template_id = "5de8179668f2033afac48da1868d0093bf133266"
437
+
438
+ begin
439
+ result = template_api.template_files_as_file_url(template_id)
440
+ p result
441
+ rescue Dropbox::Sign::ApiError => e
442
+ puts "Exception when calling Dropbox Sign API: #{e}"
443
+ end
444
+
445
+ ```
446
+
447
+ #### Using the `template_files_as_file_url_with_http_info` variant
448
+
449
+ This returns an Array which contains the response data, status code and headers.
450
+
451
+ > `<Array(<FileResponse>, Integer, Hash)> template_files_as_file_url_with_http_info(template_id)`
452
+
453
+ ```ruby
454
+ begin
455
+ # Get Template Files as File Url
456
+ data, status_code, headers = api_instance.template_files_as_file_url_with_http_info(template_id)
457
+ p status_code # => 2xx
458
+ p headers # => { ... }
459
+ p data # => <FileResponse>
460
+ rescue Dropbox::Sign::ApiError => e
461
+ puts "Error when calling TemplateApi->template_files_as_file_url_with_http_info: #{e}"
462
+ end
463
+ ```
464
+
465
+ ### Parameters
466
+
467
+ | Name | Type | Description | Notes |
468
+ | ---- | ---- | ----------- | ----- |
469
+ | `template_id` | **String** | The id of the template files to retrieve. | |
470
+
471
+ ### Return type
472
+
473
+ [**FileResponse**](FileResponse.md)
474
+
475
+ ### Authorization
476
+
477
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
478
+
479
+ ### HTTP request headers
480
+
481
+ - **Content-Type**: Not defined
482
+ - **Accept**: application/json
483
+
484
+
485
+ ## `template_get`
486
+
487
+ > `<TemplateGetResponse> template_get(template_id)`
488
+
489
+ Get Template
490
+
491
+ Returns the Template specified by the `template_id` parameter.
492
+
493
+ ### Examples
494
+
495
+ ```ruby
496
+ require "dropbox-sign"
497
+
498
+ Dropbox::Sign.configure do |config|
499
+ # Configure HTTP basic authorization: api_key
500
+ config.username = "YOUR_API_KEY"
501
+
502
+ # or, configure Bearer (JWT) authorization: oauth2
503
+ # config.access_token = "YOUR_ACCESS_TOKEN"
504
+ end
505
+
506
+ template_api = Dropbox::Sign::TemplateApi.new
507
+
508
+ template_id = "f57db65d3f933b5316d398057a36176831451a35"
509
+
510
+ begin
511
+ result = template_api.template_get(template_id)
512
+ p result
513
+ rescue Dropbox::Sign::ApiError => e
514
+ puts "Exception when calling Dropbox Sign API: #{e}"
515
+ end
516
+
517
+ ```
518
+
519
+ #### Using the `template_get_with_http_info` variant
520
+
521
+ This returns an Array which contains the response data, status code and headers.
522
+
523
+ > `<Array(<TemplateGetResponse>, Integer, Hash)> template_get_with_http_info(template_id)`
524
+
525
+ ```ruby
526
+ begin
527
+ # Get Template
528
+ data, status_code, headers = api_instance.template_get_with_http_info(template_id)
529
+ p status_code # => 2xx
530
+ p headers # => { ... }
531
+ p data # => <TemplateGetResponse>
532
+ rescue Dropbox::Sign::ApiError => e
533
+ puts "Error when calling TemplateApi->template_get_with_http_info: #{e}"
534
+ end
535
+ ```
536
+
537
+ ### Parameters
538
+
539
+ | Name | Type | Description | Notes |
540
+ | ---- | ---- | ----------- | ----- |
541
+ | `template_id` | **String** | The id of the Template to retrieve. | |
542
+
543
+ ### Return type
544
+
545
+ [**TemplateGetResponse**](TemplateGetResponse.md)
546
+
547
+ ### Authorization
548
+
549
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
550
+
551
+ ### HTTP request headers
552
+
553
+ - **Content-Type**: Not defined
554
+ - **Accept**: application/json
555
+
556
+
557
+ ## `template_list`
558
+
559
+ > `<TemplateListResponse> template_list(opts)`
560
+
561
+ List Templates
562
+
563
+ Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
564
+
565
+ ### Examples
566
+
567
+ ```ruby
568
+ require "dropbox-sign"
569
+
570
+ Dropbox::Sign.configure do |config|
571
+ # Configure HTTP basic authorization: api_key
572
+ config.username = "YOUR_API_KEY"
573
+
574
+ # or, configure Bearer (JWT) authorization: oauth2
575
+ # config.access_token = "YOUR_ACCESS_TOKEN"
576
+ end
577
+
578
+ template_api = Dropbox::Sign::TemplateApi.new
579
+
580
+ account_id = "f57db65d3f933b5316d398057a36176831451a35"
581
+
582
+ begin
583
+ result = template_api.template_list({account_id: account_id})
584
+ p result
585
+ rescue Dropbox::Sign::ApiError => e
586
+ puts "Exception when calling Dropbox Sign API: #{e}"
587
+ end
588
+
589
+ ```
590
+
591
+ #### Using the `template_list_with_http_info` variant
592
+
593
+ This returns an Array which contains the response data, status code and headers.
594
+
595
+ > `<Array(<TemplateListResponse>, Integer, Hash)> template_list_with_http_info(opts)`
596
+
597
+ ```ruby
598
+ begin
599
+ # List Templates
600
+ data, status_code, headers = api_instance.template_list_with_http_info(opts)
601
+ p status_code # => 2xx
602
+ p headers # => { ... }
603
+ p data # => <TemplateListResponse>
604
+ rescue Dropbox::Sign::ApiError => e
605
+ puts "Error when calling TemplateApi->template_list_with_http_info: #{e}"
606
+ end
607
+ ```
608
+
609
+ ### Parameters
610
+
611
+ | Name | Type | Description | Notes |
612
+ | ---- | ---- | ----------- | ----- |
613
+ | `account_id` | **String** | Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional] |
614
+ | `page` | **Integer** | Which page number of the Template List to return. Defaults to `1`. | [optional][default to 1] |
615
+ | `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] |
616
+ | `query` | **String** | String that includes search terms and/or fields to be used to filter the Template objects. | [optional] |
617
+
618
+ ### Return type
619
+
620
+ [**TemplateListResponse**](TemplateListResponse.md)
621
+
622
+ ### Authorization
623
+
624
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
625
+
626
+ ### HTTP request headers
627
+
628
+ - **Content-Type**: Not defined
629
+ - **Accept**: application/json
630
+
631
+
632
+ ## `template_remove_user`
633
+
634
+ > `<TemplateGetResponse> template_remove_user(template_id, template_remove_user_request)`
635
+
636
+ Remove User from Template
637
+
638
+ Removes the specified Account's access to the specified Template.
639
+
640
+ ### Examples
641
+
642
+ ```ruby
643
+ require "dropbox-sign"
644
+
645
+ Dropbox::Sign.configure do |config|
646
+ # Configure HTTP basic authorization: api_key
647
+ config.username = "YOUR_API_KEY"
648
+
649
+ # or, configure Bearer (JWT) authorization: oauth2
650
+ # config.access_token = "YOUR_ACCESS_TOKEN"
651
+ end
652
+
653
+ template_api = Dropbox::Sign::TemplateApi.new
654
+
655
+ data = Dropbox::Sign::TemplateRemoveUserRequest.new
656
+ data.email_address = "george@dropboxsign.com"
657
+
658
+ template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536"
659
+
660
+ begin
661
+ result = template_api.template_remove_user(template_id, data)
662
+ p result
663
+ rescue Dropbox::Sign::ApiError => e
664
+ puts "Exception when calling Dropbox Sign API: #{e}"
665
+ end
666
+
667
+ ```
668
+
669
+ #### Using the `template_remove_user_with_http_info` variant
670
+
671
+ This returns an Array which contains the response data, status code and headers.
672
+
673
+ > `<Array(<TemplateGetResponse>, Integer, Hash)> template_remove_user_with_http_info(template_id, template_remove_user_request)`
674
+
675
+ ```ruby
676
+ begin
677
+ # Remove User from Template
678
+ data, status_code, headers = api_instance.template_remove_user_with_http_info(template_id, template_remove_user_request)
679
+ p status_code # => 2xx
680
+ p headers # => { ... }
681
+ p data # => <TemplateGetResponse>
682
+ rescue Dropbox::Sign::ApiError => e
683
+ puts "Error when calling TemplateApi->template_remove_user_with_http_info: #{e}"
684
+ end
685
+ ```
686
+
687
+ ### Parameters
688
+
689
+ | Name | Type | Description | Notes |
690
+ | ---- | ---- | ----------- | ----- |
691
+ | `template_id` | **String** | The id of the Template to remove the Account&#39;s access to. | |
692
+ | `template_remove_user_request` | [**TemplateRemoveUserRequest**](TemplateRemoveUserRequest.md) | | |
693
+
694
+ ### Return type
695
+
696
+ [**TemplateGetResponse**](TemplateGetResponse.md)
697
+
698
+ ### Authorization
699
+
700
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
701
+
702
+ ### HTTP request headers
703
+
704
+ - **Content-Type**: application/json
705
+ - **Accept**: application/json
706
+
707
+
708
+ ## `template_update_files`
709
+
710
+ > `<TemplateUpdateFilesResponse> template_update_files(template_id, template_update_files_request)`
711
+
712
+ Update Template Files
713
+
714
+ Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
715
+
716
+ ### Examples
717
+
718
+ ```ruby
719
+ require "dropbox-sign"
720
+
721
+ Dropbox::Sign.configure do |config|
722
+ # Configure HTTP basic authorization: api_key
723
+ config.username = "YOUR_API_KEY"
724
+
725
+ # or, configure Bearer (JWT) authorization: oauth2
726
+ # config.access_token = "YOUR_ACCESS_TOKEN"
727
+ end
728
+
729
+ template_api = Dropbox::Sign::TemplateApi.new
730
+
731
+ data = Dropbox::Sign::TemplateUpdateFilesRequest.new
732
+ data.files = [File.new("example_signature_request.pdf", "r")]
733
+
734
+ template_id = "5de8179668f2033afac48da1868d0093bf133266"
735
+
736
+ begin
737
+ result = template_api.template_update_files(template_id, data)
738
+ p result
739
+ rescue Dropbox::Sign::ApiError => e
740
+ puts "Exception when calling Dropbox Sign API: #{e}"
741
+ end
742
+
743
+ ```
744
+
745
+ #### Using the `template_update_files_with_http_info` variant
746
+
747
+ This returns an Array which contains the response data, status code and headers.
748
+
749
+ > `<Array(<TemplateUpdateFilesResponse>, Integer, Hash)> template_update_files_with_http_info(template_id, template_update_files_request)`
750
+
751
+ ```ruby
752
+ begin
753
+ # Update Template Files
754
+ data, status_code, headers = api_instance.template_update_files_with_http_info(template_id, template_update_files_request)
755
+ p status_code # => 2xx
756
+ p headers # => { ... }
757
+ p data # => <TemplateUpdateFilesResponse>
758
+ rescue Dropbox::Sign::ApiError => e
759
+ puts "Error when calling TemplateApi->template_update_files_with_http_info: #{e}"
760
+ end
761
+ ```
762
+
763
+ ### Parameters
764
+
765
+ | Name | Type | Description | Notes |
766
+ | ---- | ---- | ----------- | ----- |
767
+ | `template_id` | **String** | The ID of the template whose files to update. | |
768
+ | `template_update_files_request` | [**TemplateUpdateFilesRequest**](TemplateUpdateFilesRequest.md) | | |
769
+
770
+ ### Return type
771
+
772
+ [**TemplateUpdateFilesResponse**](TemplateUpdateFilesResponse.md)
773
+
774
+ ### Authorization
775
+
776
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
777
+
778
+ ### HTTP request headers
779
+
780
+ - **Content-Type**: application/json, multipart/form-data
781
+ - **Accept**: application/json
782
+