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,1037 @@
1
+ =begin
2
+ #Dropbox Sign API
3
+
4
+ #Dropbox Sign v3 API
5
+
6
+ The version of the OpenAPI document: 3.0.0
7
+ Contact: apisupport@hellosign.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Dropbox
16
+ end
17
+
18
+ module Dropbox::Sign
19
+ class TemplateApi
20
+ attr_accessor :api_client
21
+
22
+ def initialize(api_client = ApiClient.default)
23
+ @api_client = api_client
24
+ end
25
+ # Add User to Template
26
+ # Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
27
+ # @param template_id [String] The id of the Template to give the Account access to.
28
+ # @param template_add_user_request [TemplateAddUserRequest]
29
+ # @param [Hash] opts the optional parameters
30
+ # @return [TemplateGetResponse]
31
+ def template_add_user(template_id, template_add_user_request, opts = {})
32
+ data, _status_code, _headers = template_add_user_with_http_info(template_id, template_add_user_request, opts)
33
+ data
34
+ end
35
+
36
+ # Add User to Template
37
+ # Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
38
+ # @param template_id [String] The id of the Template to give the Account access to.
39
+ # @param template_add_user_request [TemplateAddUserRequest]
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(TemplateGetResponse, Integer, Hash)>] TemplateGetResponse data, response status code and response headers
42
+ def template_add_user_with_http_info(template_id, template_add_user_request, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_add_user ...'
45
+ end
46
+ # verify the required parameter 'template_id' is set
47
+ if @api_client.config.client_side_validation && template_id.nil?
48
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplateApi.template_add_user"
49
+ end
50
+ # verify the required parameter 'template_add_user_request' is set
51
+ if @api_client.config.client_side_validation && template_add_user_request.nil?
52
+ fail ArgumentError, "Missing the required parameter 'template_add_user_request' when calling TemplateApi.template_add_user"
53
+ end
54
+ # resource path
55
+ local_var_path = '/template/add_user/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
56
+
57
+ # query parameters
58
+ query_params = opts[:query_params] || {}
59
+
60
+ # header parameters
61
+ header_params = opts[:header_params] || {}
62
+ # HTTP header 'Accept' (if needed)
63
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
64
+ # HTTP header 'Content-Type'
65
+ content_type = @api_client.select_header_content_type(['application/json'])
66
+ if !content_type.nil?
67
+ header_params['Content-Type'] = content_type
68
+ end
69
+
70
+ post_body = {}
71
+ form_params = opts[:form_params] || {}
72
+ result = @api_client.generate_form_data(
73
+ template_add_user_request,
74
+ Dropbox::Sign::TemplateAddUserRequest.openapi_types
75
+ )
76
+
77
+ # form parameters
78
+ if result[:has_file]
79
+ form_params = opts[:form_params] || result[:params]
80
+ header_params['Content-Type'] = 'multipart/form-data'
81
+ else
82
+ # http body (model)
83
+ post_body = opts[:debug_body] || result[:params]
84
+ end
85
+
86
+ # return_type
87
+ return_type = opts[:debug_return_type] || 'TemplateGetResponse'
88
+
89
+ # auth_names
90
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
91
+
92
+ new_options = opts.merge(
93
+ :operation => :"TemplateApi.template_add_user",
94
+ :header_params => header_params,
95
+ :query_params => query_params,
96
+ :form_params => form_params,
97
+ :body => post_body,
98
+ :auth_names => auth_names,
99
+ :return_type => return_type
100
+ )
101
+
102
+ begin
103
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
104
+ rescue Dropbox::Sign::ApiError => e
105
+ if e.code === 200
106
+ body = @api_client.convert_to_type(
107
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
108
+ "Dropbox::Sign::TemplateGetResponse"
109
+ )
110
+
111
+ fail ApiError.new(:code => e.code,
112
+ :response_headers => e.response_headers,
113
+ :response_body => body),
114
+ e.message
115
+ end
116
+
117
+ range_code = "4XX".split('').first
118
+ range_code_left = "#{range_code}00".to_i
119
+ range_code_right = "#{range_code}99".to_i
120
+ if e.code >= range_code_left && e.code <= range_code_right
121
+ body = @api_client.convert_to_type(
122
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
123
+ "Dropbox::Sign::ErrorResponse"
124
+ )
125
+
126
+ fail ApiError.new(:code => e.code,
127
+ :response_headers => e.response_headers,
128
+ :response_body => body),
129
+ e.message
130
+ end
131
+
132
+ end
133
+
134
+ if @api_client.config.debugging
135
+ @api_client.config.logger.debug "API called: TemplateApi#template_add_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
+ end
137
+ return data, status_code, headers
138
+ end
139
+
140
+ # Create Embedded Template Draft
141
+ # The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
142
+ # @param template_create_embedded_draft_request [TemplateCreateEmbeddedDraftRequest]
143
+ # @param [Hash] opts the optional parameters
144
+ # @return [TemplateCreateEmbeddedDraftResponse]
145
+ def template_create_embedded_draft(template_create_embedded_draft_request, opts = {})
146
+ data, _status_code, _headers = template_create_embedded_draft_with_http_info(template_create_embedded_draft_request, opts)
147
+ data
148
+ end
149
+
150
+ # Create Embedded Template Draft
151
+ # The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template &#39;edit&#39; stage.
152
+ # @param template_create_embedded_draft_request [TemplateCreateEmbeddedDraftRequest]
153
+ # @param [Hash] opts the optional parameters
154
+ # @return [Array<(TemplateCreateEmbeddedDraftResponse, Integer, Hash)>] TemplateCreateEmbeddedDraftResponse data, response status code and response headers
155
+ def template_create_embedded_draft_with_http_info(template_create_embedded_draft_request, opts = {})
156
+ if @api_client.config.debugging
157
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_create_embedded_draft ...'
158
+ end
159
+ # verify the required parameter 'template_create_embedded_draft_request' is set
160
+ if @api_client.config.client_side_validation && template_create_embedded_draft_request.nil?
161
+ fail ArgumentError, "Missing the required parameter 'template_create_embedded_draft_request' when calling TemplateApi.template_create_embedded_draft"
162
+ end
163
+ # resource path
164
+ local_var_path = '/template/create_embedded_draft'
165
+
166
+ # query parameters
167
+ query_params = opts[:query_params] || {}
168
+
169
+ # header parameters
170
+ header_params = opts[:header_params] || {}
171
+ # HTTP header 'Accept' (if needed)
172
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
173
+ # HTTP header 'Content-Type'
174
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
175
+ if !content_type.nil?
176
+ header_params['Content-Type'] = content_type
177
+ end
178
+
179
+ post_body = {}
180
+ form_params = opts[:form_params] || {}
181
+ result = @api_client.generate_form_data(
182
+ template_create_embedded_draft_request,
183
+ Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.openapi_types
184
+ )
185
+
186
+ # form parameters
187
+ if result[:has_file]
188
+ form_params = opts[:form_params] || result[:params]
189
+ header_params['Content-Type'] = 'multipart/form-data'
190
+ else
191
+ # http body (model)
192
+ post_body = opts[:debug_body] || result[:params]
193
+ end
194
+
195
+ # return_type
196
+ return_type = opts[:debug_return_type] || 'TemplateCreateEmbeddedDraftResponse'
197
+
198
+ # auth_names
199
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
200
+
201
+ new_options = opts.merge(
202
+ :operation => :"TemplateApi.template_create_embedded_draft",
203
+ :header_params => header_params,
204
+ :query_params => query_params,
205
+ :form_params => form_params,
206
+ :body => post_body,
207
+ :auth_names => auth_names,
208
+ :return_type => return_type
209
+ )
210
+
211
+ begin
212
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
213
+ rescue Dropbox::Sign::ApiError => e
214
+ if e.code === 200
215
+ body = @api_client.convert_to_type(
216
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
217
+ "Dropbox::Sign::TemplateCreateEmbeddedDraftResponse"
218
+ )
219
+
220
+ fail ApiError.new(:code => e.code,
221
+ :response_headers => e.response_headers,
222
+ :response_body => body),
223
+ e.message
224
+ end
225
+
226
+ range_code = "4XX".split('').first
227
+ range_code_left = "#{range_code}00".to_i
228
+ range_code_right = "#{range_code}99".to_i
229
+ if e.code >= range_code_left && e.code <= range_code_right
230
+ body = @api_client.convert_to_type(
231
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
232
+ "Dropbox::Sign::ErrorResponse"
233
+ )
234
+
235
+ fail ApiError.new(:code => e.code,
236
+ :response_headers => e.response_headers,
237
+ :response_body => body),
238
+ e.message
239
+ end
240
+
241
+ end
242
+
243
+ if @api_client.config.debugging
244
+ @api_client.config.logger.debug "API called: TemplateApi#template_create_embedded_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
245
+ end
246
+ return data, status_code, headers
247
+ end
248
+
249
+ # Delete Template
250
+ # Completely deletes the template specified from the account.
251
+ # @param template_id [String] The id of the Template to delete.
252
+ # @param [Hash] opts the optional parameters
253
+ # @return [nil]
254
+ def template_delete(template_id, opts = {})
255
+ template_delete_with_http_info(template_id, opts)
256
+ nil
257
+ end
258
+
259
+ # Delete Template
260
+ # Completely deletes the template specified from the account.
261
+ # @param template_id [String] The id of the Template to delete.
262
+ # @param [Hash] opts the optional parameters
263
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
264
+ def template_delete_with_http_info(template_id, opts = {})
265
+ if @api_client.config.debugging
266
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_delete ...'
267
+ end
268
+ # verify the required parameter 'template_id' is set
269
+ if @api_client.config.client_side_validation && template_id.nil?
270
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplateApi.template_delete"
271
+ end
272
+ # resource path
273
+ local_var_path = '/template/delete/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
274
+
275
+ # query parameters
276
+ query_params = opts[:query_params] || {}
277
+
278
+ # header parameters
279
+ header_params = opts[:header_params] || {}
280
+ # HTTP header 'Accept' (if needed)
281
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
282
+
283
+ post_body = {}
284
+ form_params = opts[:form_params] || {}
285
+
286
+ # http body (model)
287
+ post_body = opts[:debug_body]
288
+
289
+ # return_type
290
+ return_type = opts[:debug_return_type]
291
+
292
+ # auth_names
293
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
294
+
295
+ new_options = opts.merge(
296
+ :operation => :"TemplateApi.template_delete",
297
+ :header_params => header_params,
298
+ :query_params => query_params,
299
+ :form_params => form_params,
300
+ :body => post_body,
301
+ :auth_names => auth_names,
302
+ :return_type => return_type
303
+ )
304
+
305
+ begin
306
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
307
+ rescue Dropbox::Sign::ApiError => e
308
+ end
309
+
310
+ if @api_client.config.debugging
311
+ @api_client.config.logger.debug "API called: TemplateApi#template_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
312
+ end
313
+ return data, status_code, headers
314
+ end
315
+
316
+ # Get Template Files
317
+ # 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.
318
+ # @param template_id [String] The id of the template files to retrieve.
319
+ # @param [Hash] opts the optional parameters
320
+ # @option opts [String] :file_type Set to &#x60;pdf&#x60; for a single merged document or &#x60;zip&#x60; for a collection of individual documents.
321
+ # @return [File]
322
+ def template_files(template_id, opts = {})
323
+ data, _status_code, _headers = template_files_with_http_info(template_id, opts)
324
+ data
325
+ end
326
+
327
+ # Get Template Files
328
+ # Obtain a copy of the current documents specified by the &#x60;template_id&#x60; parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead. In this case please wait for the &#x60;template_created&#x60; callback event.
329
+ # @param template_id [String] The id of the template files to retrieve.
330
+ # @param [Hash] opts the optional parameters
331
+ # @option opts [String] :file_type Set to &#x60;pdf&#x60; for a single merged document or &#x60;zip&#x60; for a collection of individual documents.
332
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
333
+ def template_files_with_http_info(template_id, opts = {})
334
+ if @api_client.config.debugging
335
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_files ...'
336
+ end
337
+ # verify the required parameter 'template_id' is set
338
+ if @api_client.config.client_side_validation && template_id.nil?
339
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplateApi.template_files"
340
+ end
341
+ allowable_values = ["pdf", "zip"]
342
+ if @api_client.config.client_side_validation && opts[:'file_type'] && !allowable_values.include?(opts[:'file_type'])
343
+ fail ArgumentError, "invalid value for \"file_type\", must be one of #{allowable_values}"
344
+ end
345
+ # resource path
346
+ local_var_path = '/template/files/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
347
+
348
+ # query parameters
349
+ query_params = opts[:query_params] || {}
350
+ query_params[:'file_type'] = opts[:'file_type'] if !opts[:'file_type'].nil?
351
+
352
+ # header parameters
353
+ header_params = opts[:header_params] || {}
354
+ # HTTP header 'Accept' (if needed)
355
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/zip', 'application/json'])
356
+
357
+ post_body = {}
358
+ form_params = opts[:form_params] || {}
359
+
360
+ # http body (model)
361
+ post_body = opts[:debug_body]
362
+
363
+ # return_type
364
+ return_type = opts[:debug_return_type] || 'File'
365
+
366
+ # auth_names
367
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
368
+
369
+ new_options = opts.merge(
370
+ :operation => :"TemplateApi.template_files",
371
+ :header_params => header_params,
372
+ :query_params => query_params,
373
+ :form_params => form_params,
374
+ :body => post_body,
375
+ :auth_names => auth_names,
376
+ :return_type => return_type
377
+ )
378
+
379
+ begin
380
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
381
+ rescue Dropbox::Sign::ApiError => e
382
+ if e.code === 200
383
+ body = @api_client.convert_to_type(
384
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
385
+ "Dropbox::Sign::File"
386
+ )
387
+
388
+ fail ApiError.new(:code => e.code,
389
+ :response_headers => e.response_headers,
390
+ :response_body => body),
391
+ e.message
392
+ end
393
+
394
+ range_code = "4XX".split('').first
395
+ range_code_left = "#{range_code}00".to_i
396
+ range_code_right = "#{range_code}99".to_i
397
+ if e.code >= range_code_left && e.code <= range_code_right
398
+ body = @api_client.convert_to_type(
399
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
400
+ "Dropbox::Sign::ErrorResponse"
401
+ )
402
+
403
+ fail ApiError.new(:code => e.code,
404
+ :response_headers => e.response_headers,
405
+ :response_body => body),
406
+ e.message
407
+ end
408
+
409
+ end
410
+
411
+ if @api_client.config.debugging
412
+ @api_client.config.logger.debug "API called: TemplateApi#template_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
413
+ end
414
+ return data, status_code, headers
415
+ end
416
+
417
+ # Get Template Files as Data Uri
418
+ # 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.
419
+ # @param template_id [String] The id of the template files to retrieve.
420
+ # @param [Hash] opts the optional parameters
421
+ # @return [FileResponseDataUri]
422
+ def template_files_as_data_uri(template_id, opts = {})
423
+ data, _status_code, _headers = template_files_as_data_uri_with_http_info(template_id, opts)
424
+ data
425
+ end
426
+
427
+ # Get Template Files as Data Uri
428
+ # Obtain a copy of the current documents specified by the &#x60;template_id&#x60; parameter. Returns a JSON object with a &#x60;data_uri&#x60; representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead. In this case please wait for the &#x60;template_created&#x60; callback event.
429
+ # @param template_id [String] The id of the template files to retrieve.
430
+ # @param [Hash] opts the optional parameters
431
+ # @return [Array<(FileResponseDataUri, Integer, Hash)>] FileResponseDataUri data, response status code and response headers
432
+ def template_files_as_data_uri_with_http_info(template_id, opts = {})
433
+ if @api_client.config.debugging
434
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_files_as_data_uri ...'
435
+ end
436
+ # verify the required parameter 'template_id' is set
437
+ if @api_client.config.client_side_validation && template_id.nil?
438
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplateApi.template_files_as_data_uri"
439
+ end
440
+ # resource path
441
+ local_var_path = '/template/files_as_data_uri/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
442
+
443
+ # query parameters
444
+ query_params = opts[:query_params] || {}
445
+
446
+ # header parameters
447
+ header_params = opts[:header_params] || {}
448
+ # HTTP header 'Accept' (if needed)
449
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
450
+
451
+ post_body = {}
452
+ form_params = opts[:form_params] || {}
453
+
454
+ # http body (model)
455
+ post_body = opts[:debug_body]
456
+
457
+ # return_type
458
+ return_type = opts[:debug_return_type] || 'FileResponseDataUri'
459
+
460
+ # auth_names
461
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
462
+
463
+ new_options = opts.merge(
464
+ :operation => :"TemplateApi.template_files_as_data_uri",
465
+ :header_params => header_params,
466
+ :query_params => query_params,
467
+ :form_params => form_params,
468
+ :body => post_body,
469
+ :auth_names => auth_names,
470
+ :return_type => return_type
471
+ )
472
+
473
+ begin
474
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
475
+ rescue Dropbox::Sign::ApiError => e
476
+ if e.code === 200
477
+ body = @api_client.convert_to_type(
478
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
479
+ "Dropbox::Sign::FileResponseDataUri"
480
+ )
481
+
482
+ fail ApiError.new(:code => e.code,
483
+ :response_headers => e.response_headers,
484
+ :response_body => body),
485
+ e.message
486
+ end
487
+
488
+ range_code = "4XX".split('').first
489
+ range_code_left = "#{range_code}00".to_i
490
+ range_code_right = "#{range_code}99".to_i
491
+ if e.code >= range_code_left && e.code <= range_code_right
492
+ body = @api_client.convert_to_type(
493
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
494
+ "Dropbox::Sign::ErrorResponse"
495
+ )
496
+
497
+ fail ApiError.new(:code => e.code,
498
+ :response_headers => e.response_headers,
499
+ :response_body => body),
500
+ e.message
501
+ end
502
+
503
+ end
504
+
505
+ if @api_client.config.debugging
506
+ @api_client.config.logger.debug "API called: TemplateApi#template_files_as_data_uri\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
507
+ end
508
+ return data, status_code, headers
509
+ end
510
+
511
+ # Get Template Files as File Url
512
+ # 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.
513
+ # @param template_id [String] The id of the template files to retrieve.
514
+ # @param [Hash] opts the optional parameters
515
+ # @return [FileResponse]
516
+ def template_files_as_file_url(template_id, opts = {})
517
+ data, _status_code, _headers = template_files_as_file_url_with_http_info(template_id, opts)
518
+ data
519
+ end
520
+
521
+ # Get Template Files as File Url
522
+ # Obtain a copy of the current documents specified by the &#x60;template_id&#x60; parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead. In this case please wait for the &#x60;template_created&#x60; callback event.
523
+ # @param template_id [String] The id of the template files to retrieve.
524
+ # @param [Hash] opts the optional parameters
525
+ # @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
526
+ def template_files_as_file_url_with_http_info(template_id, opts = {})
527
+ if @api_client.config.debugging
528
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_files_as_file_url ...'
529
+ end
530
+ # verify the required parameter 'template_id' is set
531
+ if @api_client.config.client_side_validation && template_id.nil?
532
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplateApi.template_files_as_file_url"
533
+ end
534
+ # resource path
535
+ local_var_path = '/template/files_as_file_url/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
536
+
537
+ # query parameters
538
+ query_params = opts[:query_params] || {}
539
+
540
+ # header parameters
541
+ header_params = opts[:header_params] || {}
542
+ # HTTP header 'Accept' (if needed)
543
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
544
+
545
+ post_body = {}
546
+ form_params = opts[:form_params] || {}
547
+
548
+ # http body (model)
549
+ post_body = opts[:debug_body]
550
+
551
+ # return_type
552
+ return_type = opts[:debug_return_type] || 'FileResponse'
553
+
554
+ # auth_names
555
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
556
+
557
+ new_options = opts.merge(
558
+ :operation => :"TemplateApi.template_files_as_file_url",
559
+ :header_params => header_params,
560
+ :query_params => query_params,
561
+ :form_params => form_params,
562
+ :body => post_body,
563
+ :auth_names => auth_names,
564
+ :return_type => return_type
565
+ )
566
+
567
+ begin
568
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
569
+ rescue Dropbox::Sign::ApiError => e
570
+ if e.code === 200
571
+ body = @api_client.convert_to_type(
572
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
573
+ "Dropbox::Sign::FileResponse"
574
+ )
575
+
576
+ fail ApiError.new(:code => e.code,
577
+ :response_headers => e.response_headers,
578
+ :response_body => body),
579
+ e.message
580
+ end
581
+
582
+ range_code = "4XX".split('').first
583
+ range_code_left = "#{range_code}00".to_i
584
+ range_code_right = "#{range_code}99".to_i
585
+ if e.code >= range_code_left && e.code <= range_code_right
586
+ body = @api_client.convert_to_type(
587
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
588
+ "Dropbox::Sign::ErrorResponse"
589
+ )
590
+
591
+ fail ApiError.new(:code => e.code,
592
+ :response_headers => e.response_headers,
593
+ :response_body => body),
594
+ e.message
595
+ end
596
+
597
+ end
598
+
599
+ if @api_client.config.debugging
600
+ @api_client.config.logger.debug "API called: TemplateApi#template_files_as_file_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
601
+ end
602
+ return data, status_code, headers
603
+ end
604
+
605
+ # Get Template
606
+ # Returns the Template specified by the `template_id` parameter.
607
+ # @param template_id [String] The id of the Template to retrieve.
608
+ # @param [Hash] opts the optional parameters
609
+ # @return [TemplateGetResponse]
610
+ def template_get(template_id, opts = {})
611
+ data, _status_code, _headers = template_get_with_http_info(template_id, opts)
612
+ data
613
+ end
614
+
615
+ # Get Template
616
+ # Returns the Template specified by the &#x60;template_id&#x60; parameter.
617
+ # @param template_id [String] The id of the Template to retrieve.
618
+ # @param [Hash] opts the optional parameters
619
+ # @return [Array<(TemplateGetResponse, Integer, Hash)>] TemplateGetResponse data, response status code and response headers
620
+ def template_get_with_http_info(template_id, opts = {})
621
+ if @api_client.config.debugging
622
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_get ...'
623
+ end
624
+ # verify the required parameter 'template_id' is set
625
+ if @api_client.config.client_side_validation && template_id.nil?
626
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplateApi.template_get"
627
+ end
628
+ # resource path
629
+ local_var_path = '/template/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
630
+
631
+ # query parameters
632
+ query_params = opts[:query_params] || {}
633
+
634
+ # header parameters
635
+ header_params = opts[:header_params] || {}
636
+ # HTTP header 'Accept' (if needed)
637
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
638
+
639
+ post_body = {}
640
+ form_params = opts[:form_params] || {}
641
+
642
+ # http body (model)
643
+ post_body = opts[:debug_body]
644
+
645
+ # return_type
646
+ return_type = opts[:debug_return_type] || 'TemplateGetResponse'
647
+
648
+ # auth_names
649
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
650
+
651
+ new_options = opts.merge(
652
+ :operation => :"TemplateApi.template_get",
653
+ :header_params => header_params,
654
+ :query_params => query_params,
655
+ :form_params => form_params,
656
+ :body => post_body,
657
+ :auth_names => auth_names,
658
+ :return_type => return_type
659
+ )
660
+
661
+ begin
662
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
663
+ rescue Dropbox::Sign::ApiError => e
664
+ if e.code === 200
665
+ body = @api_client.convert_to_type(
666
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
667
+ "Dropbox::Sign::TemplateGetResponse"
668
+ )
669
+
670
+ fail ApiError.new(:code => e.code,
671
+ :response_headers => e.response_headers,
672
+ :response_body => body),
673
+ e.message
674
+ end
675
+
676
+ range_code = "4XX".split('').first
677
+ range_code_left = "#{range_code}00".to_i
678
+ range_code_right = "#{range_code}99".to_i
679
+ if e.code >= range_code_left && e.code <= range_code_right
680
+ body = @api_client.convert_to_type(
681
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
682
+ "Dropbox::Sign::ErrorResponse"
683
+ )
684
+
685
+ fail ApiError.new(:code => e.code,
686
+ :response_headers => e.response_headers,
687
+ :response_body => body),
688
+ e.message
689
+ end
690
+
691
+ end
692
+
693
+ if @api_client.config.debugging
694
+ @api_client.config.logger.debug "API called: TemplateApi#template_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
695
+ end
696
+ return data, status_code, headers
697
+ end
698
+
699
+ # List Templates
700
+ # 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.
701
+ # @param [Hash] opts the optional parameters
702
+ # @option opts [String] :account_id Which account to return Templates for. Must be a team member. Use &#x60;all&#x60; to indicate all team members. Defaults to your account.
703
+ # @option opts [Integer] :page Which page number of the Template List to return. Defaults to &#x60;1&#x60;. (default to 1)
704
+ # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;. (default to 20)
705
+ # @option opts [String] :query String that includes search terms and/or fields to be used to filter the Template objects.
706
+ # @return [TemplateListResponse]
707
+ def template_list(opts = {})
708
+ data, _status_code, _headers = template_list_with_http_info(opts)
709
+ data
710
+ end
711
+
712
+ # List Templates
713
+ # 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.
714
+ # @param [Hash] opts the optional parameters
715
+ # @option opts [String] :account_id Which account to return Templates for. Must be a team member. Use &#x60;all&#x60; to indicate all team members. Defaults to your account.
716
+ # @option opts [Integer] :page Which page number of the Template List to return. Defaults to &#x60;1&#x60;.
717
+ # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;.
718
+ # @option opts [String] :query String that includes search terms and/or fields to be used to filter the Template objects.
719
+ # @return [Array<(TemplateListResponse, Integer, Hash)>] TemplateListResponse data, response status code and response headers
720
+ def template_list_with_http_info(opts = {})
721
+ if @api_client.config.debugging
722
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_list ...'
723
+ end
724
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
725
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TemplateApi.template_list, must be smaller than or equal to 100.'
726
+ end
727
+
728
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
729
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TemplateApi.template_list, must be greater than or equal to 1.'
730
+ end
731
+
732
+ # resource path
733
+ local_var_path = '/template/list'
734
+
735
+ # query parameters
736
+ query_params = opts[:query_params] || {}
737
+ query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
738
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
739
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
740
+ query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
741
+
742
+ # header parameters
743
+ header_params = opts[:header_params] || {}
744
+ # HTTP header 'Accept' (if needed)
745
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
746
+
747
+ post_body = {}
748
+ form_params = opts[:form_params] || {}
749
+
750
+ # http body (model)
751
+ post_body = opts[:debug_body]
752
+
753
+ # return_type
754
+ return_type = opts[:debug_return_type] || 'TemplateListResponse'
755
+
756
+ # auth_names
757
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
758
+
759
+ new_options = opts.merge(
760
+ :operation => :"TemplateApi.template_list",
761
+ :header_params => header_params,
762
+ :query_params => query_params,
763
+ :form_params => form_params,
764
+ :body => post_body,
765
+ :auth_names => auth_names,
766
+ :return_type => return_type
767
+ )
768
+
769
+ begin
770
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
771
+ rescue Dropbox::Sign::ApiError => e
772
+ if e.code === 200
773
+ body = @api_client.convert_to_type(
774
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
775
+ "Dropbox::Sign::TemplateListResponse"
776
+ )
777
+
778
+ fail ApiError.new(:code => e.code,
779
+ :response_headers => e.response_headers,
780
+ :response_body => body),
781
+ e.message
782
+ end
783
+
784
+ range_code = "4XX".split('').first
785
+ range_code_left = "#{range_code}00".to_i
786
+ range_code_right = "#{range_code}99".to_i
787
+ if e.code >= range_code_left && e.code <= range_code_right
788
+ body = @api_client.convert_to_type(
789
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
790
+ "Dropbox::Sign::ErrorResponse"
791
+ )
792
+
793
+ fail ApiError.new(:code => e.code,
794
+ :response_headers => e.response_headers,
795
+ :response_body => body),
796
+ e.message
797
+ end
798
+
799
+ end
800
+
801
+ if @api_client.config.debugging
802
+ @api_client.config.logger.debug "API called: TemplateApi#template_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
803
+ end
804
+ return data, status_code, headers
805
+ end
806
+
807
+ # Remove User from Template
808
+ # Removes the specified Account's access to the specified Template.
809
+ # @param template_id [String] The id of the Template to remove the Account&#39;s access to.
810
+ # @param template_remove_user_request [TemplateRemoveUserRequest]
811
+ # @param [Hash] opts the optional parameters
812
+ # @return [TemplateGetResponse]
813
+ def template_remove_user(template_id, template_remove_user_request, opts = {})
814
+ data, _status_code, _headers = template_remove_user_with_http_info(template_id, template_remove_user_request, opts)
815
+ data
816
+ end
817
+
818
+ # Remove User from Template
819
+ # Removes the specified Account&#39;s access to the specified Template.
820
+ # @param template_id [String] The id of the Template to remove the Account&#39;s access to.
821
+ # @param template_remove_user_request [TemplateRemoveUserRequest]
822
+ # @param [Hash] opts the optional parameters
823
+ # @return [Array<(TemplateGetResponse, Integer, Hash)>] TemplateGetResponse data, response status code and response headers
824
+ def template_remove_user_with_http_info(template_id, template_remove_user_request, opts = {})
825
+ if @api_client.config.debugging
826
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_remove_user ...'
827
+ end
828
+ # verify the required parameter 'template_id' is set
829
+ if @api_client.config.client_side_validation && template_id.nil?
830
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplateApi.template_remove_user"
831
+ end
832
+ # verify the required parameter 'template_remove_user_request' is set
833
+ if @api_client.config.client_side_validation && template_remove_user_request.nil?
834
+ fail ArgumentError, "Missing the required parameter 'template_remove_user_request' when calling TemplateApi.template_remove_user"
835
+ end
836
+ # resource path
837
+ local_var_path = '/template/remove_user/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
838
+
839
+ # query parameters
840
+ query_params = opts[:query_params] || {}
841
+
842
+ # header parameters
843
+ header_params = opts[:header_params] || {}
844
+ # HTTP header 'Accept' (if needed)
845
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
846
+ # HTTP header 'Content-Type'
847
+ content_type = @api_client.select_header_content_type(['application/json'])
848
+ if !content_type.nil?
849
+ header_params['Content-Type'] = content_type
850
+ end
851
+
852
+ post_body = {}
853
+ form_params = opts[:form_params] || {}
854
+ result = @api_client.generate_form_data(
855
+ template_remove_user_request,
856
+ Dropbox::Sign::TemplateRemoveUserRequest.openapi_types
857
+ )
858
+
859
+ # form parameters
860
+ if result[:has_file]
861
+ form_params = opts[:form_params] || result[:params]
862
+ header_params['Content-Type'] = 'multipart/form-data'
863
+ else
864
+ # http body (model)
865
+ post_body = opts[:debug_body] || result[:params]
866
+ end
867
+
868
+ # return_type
869
+ return_type = opts[:debug_return_type] || 'TemplateGetResponse'
870
+
871
+ # auth_names
872
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
873
+
874
+ new_options = opts.merge(
875
+ :operation => :"TemplateApi.template_remove_user",
876
+ :header_params => header_params,
877
+ :query_params => query_params,
878
+ :form_params => form_params,
879
+ :body => post_body,
880
+ :auth_names => auth_names,
881
+ :return_type => return_type
882
+ )
883
+
884
+ begin
885
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
886
+ rescue Dropbox::Sign::ApiError => e
887
+ if e.code === 200
888
+ body = @api_client.convert_to_type(
889
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
890
+ "Dropbox::Sign::TemplateGetResponse"
891
+ )
892
+
893
+ fail ApiError.new(:code => e.code,
894
+ :response_headers => e.response_headers,
895
+ :response_body => body),
896
+ e.message
897
+ end
898
+
899
+ range_code = "4XX".split('').first
900
+ range_code_left = "#{range_code}00".to_i
901
+ range_code_right = "#{range_code}99".to_i
902
+ if e.code >= range_code_left && e.code <= range_code_right
903
+ body = @api_client.convert_to_type(
904
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
905
+ "Dropbox::Sign::ErrorResponse"
906
+ )
907
+
908
+ fail ApiError.new(:code => e.code,
909
+ :response_headers => e.response_headers,
910
+ :response_body => body),
911
+ e.message
912
+ end
913
+
914
+ end
915
+
916
+ if @api_client.config.debugging
917
+ @api_client.config.logger.debug "API called: TemplateApi#template_remove_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
918
+ end
919
+ return data, status_code, headers
920
+ end
921
+
922
+ # Update Template Files
923
+ # 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).
924
+ # @param template_id [String] The ID of the template whose files to update.
925
+ # @param template_update_files_request [TemplateUpdateFilesRequest]
926
+ # @param [Hash] opts the optional parameters
927
+ # @return [TemplateUpdateFilesResponse]
928
+ def template_update_files(template_id, template_update_files_request, opts = {})
929
+ data, _status_code, _headers = template_update_files_with_http_info(template_id, template_update_files_request, opts)
930
+ data
931
+ end
932
+
933
+ # Update Template Files
934
+ # 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 &#x60;template_created&#x60; event will be sent when the files are updated or a &#x60;template_error&#x60; 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 &#x60;template_error&#x60; [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
935
+ # @param template_id [String] The ID of the template whose files to update.
936
+ # @param template_update_files_request [TemplateUpdateFilesRequest]
937
+ # @param [Hash] opts the optional parameters
938
+ # @return [Array<(TemplateUpdateFilesResponse, Integer, Hash)>] TemplateUpdateFilesResponse data, response status code and response headers
939
+ def template_update_files_with_http_info(template_id, template_update_files_request, opts = {})
940
+ if @api_client.config.debugging
941
+ @api_client.config.logger.debug 'Calling API: TemplateApi.template_update_files ...'
942
+ end
943
+ # verify the required parameter 'template_id' is set
944
+ if @api_client.config.client_side_validation && template_id.nil?
945
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplateApi.template_update_files"
946
+ end
947
+ # verify the required parameter 'template_update_files_request' is set
948
+ if @api_client.config.client_side_validation && template_update_files_request.nil?
949
+ fail ArgumentError, "Missing the required parameter 'template_update_files_request' when calling TemplateApi.template_update_files"
950
+ end
951
+ # resource path
952
+ local_var_path = '/template/update_files/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
953
+
954
+ # query parameters
955
+ query_params = opts[:query_params] || {}
956
+
957
+ # header parameters
958
+ header_params = opts[:header_params] || {}
959
+ # HTTP header 'Accept' (if needed)
960
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
961
+ # HTTP header 'Content-Type'
962
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
963
+ if !content_type.nil?
964
+ header_params['Content-Type'] = content_type
965
+ end
966
+
967
+ post_body = {}
968
+ form_params = opts[:form_params] || {}
969
+ result = @api_client.generate_form_data(
970
+ template_update_files_request,
971
+ Dropbox::Sign::TemplateUpdateFilesRequest.openapi_types
972
+ )
973
+
974
+ # form parameters
975
+ if result[:has_file]
976
+ form_params = opts[:form_params] || result[:params]
977
+ header_params['Content-Type'] = 'multipart/form-data'
978
+ else
979
+ # http body (model)
980
+ post_body = opts[:debug_body] || result[:params]
981
+ end
982
+
983
+ # return_type
984
+ return_type = opts[:debug_return_type] || 'TemplateUpdateFilesResponse'
985
+
986
+ # auth_names
987
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
988
+
989
+ new_options = opts.merge(
990
+ :operation => :"TemplateApi.template_update_files",
991
+ :header_params => header_params,
992
+ :query_params => query_params,
993
+ :form_params => form_params,
994
+ :body => post_body,
995
+ :auth_names => auth_names,
996
+ :return_type => return_type
997
+ )
998
+
999
+ begin
1000
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1001
+ rescue Dropbox::Sign::ApiError => e
1002
+ if e.code === 200
1003
+ body = @api_client.convert_to_type(
1004
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1005
+ "Dropbox::Sign::TemplateUpdateFilesResponse"
1006
+ )
1007
+
1008
+ fail ApiError.new(:code => e.code,
1009
+ :response_headers => e.response_headers,
1010
+ :response_body => body),
1011
+ e.message
1012
+ end
1013
+
1014
+ range_code = "4XX".split('').first
1015
+ range_code_left = "#{range_code}00".to_i
1016
+ range_code_right = "#{range_code}99".to_i
1017
+ if e.code >= range_code_left && e.code <= range_code_right
1018
+ body = @api_client.convert_to_type(
1019
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1020
+ "Dropbox::Sign::ErrorResponse"
1021
+ )
1022
+
1023
+ fail ApiError.new(:code => e.code,
1024
+ :response_headers => e.response_headers,
1025
+ :response_body => body),
1026
+ e.message
1027
+ end
1028
+
1029
+ end
1030
+
1031
+ if @api_client.config.debugging
1032
+ @api_client.config.logger.debug "API called: TemplateApi#template_update_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1033
+ end
1034
+ return data, status_code, headers
1035
+ end
1036
+ end
1037
+ end