hellosign-ruby-sdk 3.7.7 → 6.0.0.pre.beta

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1124) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +5 -8
  3. data/Gemfile.lock +76 -0
  4. data/LICENSE +2 -2
  5. data/README.md +283 -85
  6. data/Rakefile +7 -13
  7. data/bin/generate-examples.php +269 -0
  8. data/bin/php +15 -0
  9. data/bin/replace +10 -0
  10. data/bin/ruby +15 -0
  11. data/bin/scan_for +31 -0
  12. data/composer.json +10 -0
  13. data/composer.lock +246 -0
  14. data/docs/AccountApi.md +300 -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 +18 -0
  19. data/docs/AccountResponseQuotas.md +13 -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 +32 -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/EventCallbackAccountRequest.md +10 -0
  49. data/docs/EventCallbackAccountRequestPayload.md +12 -0
  50. data/docs/EventCallbackApiAppRequest.md +10 -0
  51. data/docs/EventCallbackApiAppRequestPayload.md +13 -0
  52. data/docs/EventCallbackRequestEvent.md +13 -0
  53. data/docs/EventCallbackRequestEventMetadata.md +13 -0
  54. data/docs/FileResponse.md +11 -0
  55. data/docs/ListInfoResponse.md +13 -0
  56. data/docs/OAuthApi.md +158 -0
  57. data/docs/OAuthTokenGenerateRequest.md +14 -0
  58. data/docs/OAuthTokenRefreshRequest.md +11 -0
  59. data/docs/OAuthTokenResponse.md +14 -0
  60. data/docs/ReportApi.md +83 -0
  61. data/docs/ReportCreateRequest.md +12 -0
  62. data/docs/ReportCreateResponse.md +11 -0
  63. data/docs/ReportResponse.md +13 -0
  64. data/docs/SignatureRequestApi.md +1233 -0
  65. data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +22 -0
  66. data/docs/SignatureRequestBulkSendWithTemplateRequest.md +22 -0
  67. data/docs/SignatureRequestCreateEmbeddedRequest.md +31 -0
  68. data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +24 -0
  69. data/docs/SignatureRequestGetResponse.md +11 -0
  70. data/docs/SignatureRequestListResponse.md +12 -0
  71. data/docs/SignatureRequestRemindRequest.md +11 -0
  72. data/docs/SignatureRequestResponse.md +31 -0
  73. data/docs/SignatureRequestResponseAttachment.md +15 -0
  74. data/docs/SignatureRequestResponseCustomFieldBase.md +17 -0
  75. data/docs/SignatureRequestResponseCustomFieldCheckbox.md +11 -0
  76. data/docs/SignatureRequestResponseCustomFieldText.md +11 -0
  77. data/docs/SignatureRequestResponseCustomFieldTypeEnum.md +9 -0
  78. data/docs/SignatureRequestResponseData.md +14 -0
  79. data/docs/SignatureRequestResponseDataBase.md +14 -0
  80. data/docs/SignatureRequestResponseDataTypeEnum.md +9 -0
  81. data/docs/SignatureRequestResponseDataValueCheckbox.md +11 -0
  82. data/docs/SignatureRequestResponseDataValueCheckboxMerge.md +11 -0
  83. data/docs/SignatureRequestResponseDataValueDateSigned.md +11 -0
  84. data/docs/SignatureRequestResponseDataValueDropdown.md +11 -0
  85. data/docs/SignatureRequestResponseDataValueInitials.md +11 -0
  86. data/docs/SignatureRequestResponseDataValueRadio.md +11 -0
  87. data/docs/SignatureRequestResponseDataValueSignature.md +11 -0
  88. data/docs/SignatureRequestResponseDataValueText.md +11 -0
  89. data/docs/SignatureRequestResponseDataValueTextMerge.md +11 -0
  90. data/docs/SignatureRequestResponseSignatures.md +26 -0
  91. data/docs/SignatureRequestSendRequest.md +32 -0
  92. data/docs/SignatureRequestSendWithTemplateRequest.md +25 -0
  93. data/docs/SignatureRequestUpdateRequest.md +12 -0
  94. data/docs/SubAttachment.md +13 -0
  95. data/docs/SubBulkSignerList.md +11 -0
  96. data/docs/SubBulkSignerListCustomField.md +11 -0
  97. data/docs/SubCC.md +11 -0
  98. data/docs/SubCustomField.md +17 -0
  99. data/docs/SubEditorOptions.md +11 -0
  100. data/docs/SubFieldOptions.md +10 -0
  101. data/docs/SubFormFieldGroup.md +12 -0
  102. data/docs/SubFormFieldRule.md +13 -0
  103. data/docs/SubFormFieldRuleAction.md +13 -0
  104. data/docs/SubFormFieldRuleTrigger.md +13 -0
  105. data/docs/SubFormFieldsPerDocumentBase.md +33 -0
  106. data/docs/SubFormFieldsPerDocumentCheckbox.md +12 -0
  107. data/docs/SubFormFieldsPerDocumentCheckboxMerge.md +10 -0
  108. data/docs/SubFormFieldsPerDocumentDateSigned.md +10 -0
  109. data/docs/SubFormFieldsPerDocumentDropdown.md +12 -0
  110. data/docs/SubFormFieldsPerDocumentHyperlink.md +12 -0
  111. data/docs/SubFormFieldsPerDocumentInitials.md +10 -0
  112. data/docs/SubFormFieldsPerDocumentRadio.md +12 -0
  113. data/docs/SubFormFieldsPerDocumentSignature.md +10 -0
  114. data/docs/SubFormFieldsPerDocumentText.md +17 -0
  115. data/docs/SubFormFieldsPerDocumentTextMerge.md +10 -0
  116. data/docs/SubFormFieldsPerDocumentTypeEnum.md +9 -0
  117. data/docs/SubMergeField.md +11 -0
  118. data/docs/SubOAuth.md +11 -0
  119. data/docs/SubOptions.md +10 -0
  120. data/docs/SubSignatureRequestSigner.md +15 -0
  121. data/docs/SubSignatureRequestTemplateSigner.md +15 -0
  122. data/docs/SubSigningOptions.md +16 -0
  123. data/docs/SubTeamResponse.md +11 -0
  124. data/docs/SubTemplateRole.md +11 -0
  125. data/docs/SubUnclaimedDraftSigner.md +12 -0
  126. data/docs/SubUnclaimedDraftTemplateSigner.md +12 -0
  127. data/docs/SubWhiteLabelingOptions.md +26 -0
  128. data/docs/TeamAddMemberRequest.md +12 -0
  129. data/docs/TeamApi.md +664 -0
  130. data/docs/TeamCreateRequest.md +10 -0
  131. data/docs/TeamGetInfoResponse.md +11 -0
  132. data/docs/TeamGetResponse.md +11 -0
  133. data/docs/TeamInfoResponse.md +14 -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 +638 -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 +44 -0
  168. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +38 -0
  169. data/docs/UnclaimedDraftCreateRequest.md +32 -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/{spec/fixtures/file.json → examples/.gitkeep} +0 -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/OauthTokenGenerate.rb +24 -0
  189. data/examples/OauthTokenRefresh.rb +21 -0
  190. data/examples/ReportCreate.rb +23 -0
  191. data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
  192. data/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
  193. data/examples/SignatureRequestCancel.rb +20 -0
  194. data/examples/SignatureRequestCreateEmbedded.rb +46 -0
  195. data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
  196. data/examples/SignatureRequestFiles.rb +20 -0
  197. data/examples/SignatureRequestGet.rb +20 -0
  198. data/examples/SignatureRequestList.rb +21 -0
  199. data/examples/SignatureRequestReleaseHold.rb +20 -0
  200. data/examples/SignatureRequestRemind.rb +23 -0
  201. data/examples/SignatureRequestRemove.rb +20 -0
  202. data/examples/SignatureRequestSend.rb +56 -0
  203. data/examples/SignatureRequestSendWithTemplate.rb +50 -0
  204. data/examples/SignatureRequestUpdate.rb +24 -0
  205. data/examples/TeamAddMember.rb +21 -0
  206. data/examples/TeamCreate.rb +21 -0
  207. data/examples/TeamDelete.rb +18 -0
  208. data/examples/TeamGet.rb +18 -0
  209. data/examples/TeamInfo.rb +18 -0
  210. data/examples/TeamMembers.rb +20 -0
  211. data/examples/TeamRemoveMember.rb +22 -0
  212. data/examples/TeamSubTeams.rb +20 -0
  213. data/examples/TeamUpdate.rb +21 -0
  214. data/examples/TemplateAddUser.rb +23 -0
  215. data/examples/TemplateCreateEmbeddedDraft.rb +49 -0
  216. data/examples/TemplateDelete.rb +20 -0
  217. data/examples/TemplateFiles.rb +20 -0
  218. data/examples/TemplateGet.rb +20 -0
  219. data/examples/TemplateList.rb +20 -0
  220. data/examples/TemplateRemoveUser.rb +23 -0
  221. data/examples/TemplateUpdateFiles.rb +23 -0
  222. data/examples/UnclaimedDraftCreate.rb +56 -0
  223. data/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
  224. data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
  225. data/examples/UnclaimedDraftEditAndResend.rb +24 -0
  226. data/hellosign-ruby-sdk.gemspec +37 -52
  227. data/lib/hellosign-ruby-sdk/api/account_api.rb +440 -0
  228. data/lib/hellosign-ruby-sdk/api/api_app_api.rb +501 -0
  229. data/lib/hellosign-ruby-sdk/api/bulk_send_job_api.rb +210 -0
  230. data/lib/hellosign-ruby-sdk/api/embedded_api.rb +231 -0
  231. data/lib/hellosign-ruby-sdk/api/o_auth_api.rb +212 -0
  232. data/lib/hellosign-ruby-sdk/api/report_api.rb +131 -0
  233. data/lib/hellosign-ruby-sdk/api/signature_request_api.rb +1435 -0
  234. data/lib/hellosign-ruby-sdk/api/team_api.rb +917 -0
  235. data/lib/hellosign-ruby-sdk/api/template_api.rb +852 -0
  236. data/lib/hellosign-ruby-sdk/api/unclaimed_draft_api.rb +464 -0
  237. data/lib/hellosign-ruby-sdk/api_client.rb +414 -0
  238. data/lib/hellosign-ruby-sdk/api_error.rb +57 -0
  239. data/lib/hellosign-ruby-sdk/configuration.rb +314 -0
  240. data/lib/hellosign-ruby-sdk/event_callback_helper.rb +32 -0
  241. data/lib/hellosign-ruby-sdk/models/account_create_request.rb +284 -0
  242. data/lib/hellosign-ruby-sdk/models/account_create_response.rb +269 -0
  243. data/lib/hellosign-ruby-sdk/models/account_get_response.rb +260 -0
  244. data/lib/hellosign-ruby-sdk/models/account_response.rb +331 -0
  245. data/lib/hellosign-ruby-sdk/models/account_response_quotas.rb +284 -0
  246. data/lib/hellosign-ruby-sdk/models/account_update_request.rb +270 -0
  247. data/lib/hellosign-ruby-sdk/models/account_verify_request.rb +254 -0
  248. data/lib/hellosign-ruby-sdk/models/account_verify_response.rb +260 -0
  249. data/lib/hellosign-ruby-sdk/models/account_verify_response_account.rb +249 -0
  250. data/lib/hellosign-ruby-sdk/models/api_app_create_request.rb +346 -0
  251. data/lib/hellosign-ruby-sdk/models/api_app_get_response.rb +260 -0
  252. data/lib/hellosign-ruby-sdk/models/api_app_list_response.rb +272 -0
  253. data/lib/hellosign-ruby-sdk/models/api_app_response.rb +341 -0
  254. data/lib/hellosign-ruby-sdk/models/api_app_response_o_auth.rb +282 -0
  255. data/lib/hellosign-ruby-sdk/models/api_app_response_options.rb +250 -0
  256. data/lib/hellosign-ruby-sdk/models/api_app_response_owner_account.rb +260 -0
  257. data/lib/hellosign-ruby-sdk/models/api_app_response_white_labeling_options.rb +366 -0
  258. data/lib/hellosign-ruby-sdk/models/api_app_update_request.rb +323 -0
  259. data/lib/hellosign-ruby-sdk/models/bulk_send_job_get_response.rb +281 -0
  260. data/lib/hellosign-ruby-sdk/models/bulk_send_job_get_response_signature_requests.rb +492 -0
  261. data/lib/hellosign-ruby-sdk/models/bulk_send_job_list_response.rb +272 -0
  262. data/lib/hellosign-ruby-sdk/models/bulk_send_job_response.rb +281 -0
  263. data/lib/hellosign-ruby-sdk/models/bulk_send_job_send_response.rb +260 -0
  264. data/lib/hellosign-ruby-sdk/models/embedded_edit_url_request.rb +356 -0
  265. data/lib/hellosign-ruby-sdk/models/embedded_edit_url_response.rb +260 -0
  266. data/lib/hellosign-ruby-sdk/models/embedded_edit_url_response_embedded.rb +260 -0
  267. data/lib/hellosign-ruby-sdk/models/embedded_sign_url_response.rb +260 -0
  268. data/lib/hellosign-ruby-sdk/models/embedded_sign_url_response_embedded.rb +260 -0
  269. data/lib/hellosign-ruby-sdk/models/error_response.rb +253 -0
  270. data/lib/hellosign-ruby-sdk/models/error_response_error.rb +280 -0
  271. data/lib/hellosign-ruby-sdk/models/event_callback_account_request.rb +253 -0
  272. data/lib/hellosign-ruby-sdk/models/event_callback_account_request_payload.rb +271 -0
  273. data/lib/hellosign-ruby-sdk/models/event_callback_api_app_request.rb +253 -0
  274. data/lib/hellosign-ruby-sdk/models/event_callback_api_app_request_payload.rb +280 -0
  275. data/lib/hellosign-ruby-sdk/models/event_callback_request_event.rb +333 -0
  276. data/lib/hellosign-ruby-sdk/models/event_callback_request_event_metadata.rb +284 -0
  277. data/lib/hellosign-ruby-sdk/models/file_response.rb +259 -0
  278. data/lib/hellosign-ruby-sdk/models/list_info_response.rb +281 -0
  279. data/lib/hellosign-ruby-sdk/models/o_auth_token_generate_request.rb +316 -0
  280. data/lib/hellosign-ruby-sdk/models/o_auth_token_refresh_request.rb +271 -0
  281. data/lib/hellosign-ruby-sdk/models/o_auth_token_response.rb +286 -0
  282. data/lib/hellosign-ruby-sdk/models/report_create_request.rb +318 -0
  283. data/lib/hellosign-ruby-sdk/models/report_create_response.rb +260 -0
  284. data/lib/hellosign-ruby-sdk/models/report_response.rb +304 -0
  285. data/lib/hellosign-ruby-sdk/models/signature_request_bulk_create_embedded_with_template_request.rb +445 -0
  286. data/lib/hellosign-ruby-sdk/models/signature_request_bulk_send_with_template_request.rb +439 -0
  287. data/lib/hellosign-ruby-sdk/models/signature_request_create_embedded_request.rb +551 -0
  288. data/lib/hellosign-ruby-sdk/models/signature_request_create_embedded_with_template_request.rb +475 -0
  289. data/lib/hellosign-ruby-sdk/models/signature_request_get_response.rb +260 -0
  290. data/lib/hellosign-ruby-sdk/models/signature_request_list_response.rb +272 -0
  291. data/lib/hellosign-ruby-sdk/models/signature_request_remind_request.rb +264 -0
  292. data/lib/hellosign-ruby-sdk/models/signature_request_response.rb +483 -0
  293. data/lib/hellosign-ruby-sdk/models/signature_request_response_attachment.rb +322 -0
  294. data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_base.rb +325 -0
  295. data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_checkbox.rb +271 -0
  296. data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_text.rb +271 -0
  297. data/lib/hellosign-ruby-sdk/models/signature_request_response_custom_field_type_enum.rb +37 -0
  298. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_base.rb +335 -0
  299. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_type_enum.rb +44 -0
  300. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_checkbox.rb +265 -0
  301. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_checkbox_merge.rb +265 -0
  302. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_date_signed.rb +265 -0
  303. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_dropdown.rb +265 -0
  304. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_initials.rb +265 -0
  305. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_radio.rb +265 -0
  306. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_signature.rb +265 -0
  307. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_text.rb +265 -0
  308. data/lib/hellosign-ruby-sdk/models/signature_request_response_data_value_text_merge.rb +265 -0
  309. data/lib/hellosign-ruby-sdk/models/signature_request_response_signatures.rb +423 -0
  310. data/lib/hellosign-ruby-sdk/models/signature_request_send_request.rb +555 -0
  311. data/lib/hellosign-ruby-sdk/models/signature_request_send_with_template_request.rb +479 -0
  312. data/lib/hellosign-ruby-sdk/models/signature_request_update_request.rb +274 -0
  313. data/lib/hellosign-ruby-sdk/models/sub_attachment.rb +291 -0
  314. data/lib/hellosign-ruby-sdk/models/sub_bulk_signer_list.rb +263 -0
  315. data/lib/hellosign-ruby-sdk/models/sub_bulk_signer_list_custom_field.rb +269 -0
  316. data/lib/hellosign-ruby-sdk/models/sub_cc.rb +269 -0
  317. data/lib/hellosign-ruby-sdk/models/sub_custom_field.rb +287 -0
  318. data/lib/hellosign-ruby-sdk/models/sub_editor_options.rb +264 -0
  319. data/lib/hellosign-ruby-sdk/models/sub_field_options.rb +289 -0
  320. data/lib/hellosign-ruby-sdk/models/sub_form_field_group.rb +284 -0
  321. data/lib/hellosign-ruby-sdk/models/sub_form_field_rule.rb +352 -0
  322. data/lib/hellosign-ruby-sdk/models/sub_form_field_rule_action.rb +322 -0
  323. data/lib/hellosign-ruby-sdk/models/sub_form_field_rule_trigger.rb +325 -0
  324. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_base.rb +444 -0
  325. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_checkbox.rb +286 -0
  326. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_checkbox_merge.rb +261 -0
  327. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_date_signed.rb +261 -0
  328. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_dropdown.rb +307 -0
  329. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_hyperlink.rb +291 -0
  330. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_initials.rb +261 -0
  331. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_radio.rb +291 -0
  332. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_signature.rb +261 -0
  333. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_text.rb +363 -0
  334. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_text_merge.rb +261 -0
  335. data/lib/hellosign-ruby-sdk/models/sub_form_fields_per_document_type_enum.rb +45 -0
  336. data/lib/hellosign-ruby-sdk/models/sub_merge_field.rb +303 -0
  337. data/lib/hellosign-ruby-sdk/models/sub_o_auth.rb +284 -0
  338. data/lib/hellosign-ruby-sdk/models/sub_options.rb +252 -0
  339. data/lib/hellosign-ruby-sdk/models/sub_signature_request_signer.rb +368 -0
  340. data/lib/hellosign-ruby-sdk/models/sub_signature_request_template_signer.rb +372 -0
  341. data/lib/hellosign-ruby-sdk/models/sub_signing_options.rb +337 -0
  342. data/lib/hellosign-ruby-sdk/models/sub_team_response.rb +259 -0
  343. data/lib/hellosign-ruby-sdk/models/sub_template_role.rb +260 -0
  344. data/lib/hellosign-ruby-sdk/models/sub_unclaimed_draft_signer.rb +280 -0
  345. data/lib/hellosign-ruby-sdk/models/sub_unclaimed_draft_template_signer.rb +284 -0
  346. data/lib/hellosign-ruby-sdk/models/sub_white_labeling_options.rb +438 -0
  347. data/lib/hellosign-ruby-sdk/models/team_add_member_request.rb +303 -0
  348. data/lib/hellosign-ruby-sdk/models/team_create_request.rb +251 -0
  349. data/lib/hellosign-ruby-sdk/models/team_get_info_response.rb +260 -0
  350. data/lib/hellosign-ruby-sdk/models/team_get_response.rb +260 -0
  351. data/lib/hellosign-ruby-sdk/models/team_info_response.rb +289 -0
  352. data/lib/hellosign-ruby-sdk/models/team_member_response.rb +269 -0
  353. data/lib/hellosign-ruby-sdk/models/team_members_response.rb +271 -0
  354. data/lib/hellosign-ruby-sdk/models/team_parent_response.rb +260 -0
  355. data/lib/hellosign-ruby-sdk/models/team_remove_member_request.rb +323 -0
  356. data/lib/hellosign-ruby-sdk/models/team_response.rb +273 -0
  357. data/lib/hellosign-ruby-sdk/models/team_sub_teams_response.rb +271 -0
  358. data/lib/hellosign-ruby-sdk/models/team_update_request.rb +249 -0
  359. data/lib/hellosign-ruby-sdk/models/template_add_user_request.rb +271 -0
  360. data/lib/hellosign-ruby-sdk/models/template_create_embedded_draft_request.rb +566 -0
  361. data/lib/hellosign-ruby-sdk/models/template_create_embedded_draft_response.rb +260 -0
  362. data/lib/hellosign-ruby-sdk/models/template_create_embedded_draft_response_template.rb +282 -0
  363. data/lib/hellosign-ruby-sdk/models/template_edit_response.rb +249 -0
  364. data/lib/hellosign-ruby-sdk/models/template_get_response.rb +260 -0
  365. data/lib/hellosign-ruby-sdk/models/template_list_response.rb +272 -0
  366. data/lib/hellosign-ruby-sdk/models/template_remove_user_request.rb +259 -0
  367. data/lib/hellosign-ruby-sdk/models/template_response.rb +409 -0
  368. data/lib/hellosign-ruby-sdk/models/template_response_account.rb +298 -0
  369. data/lib/hellosign-ruby-sdk/models/template_response_account_quota.rb +280 -0
  370. data/lib/hellosign-ruby-sdk/models/template_response_cc_role.rb +249 -0
  371. data/lib/hellosign-ruby-sdk/models/template_response_custom_field.rb +406 -0
  372. data/lib/hellosign-ruby-sdk/models/template_response_document.rb +308 -0
  373. data/lib/hellosign-ruby-sdk/models/template_response_document_custom_field.rb +437 -0
  374. data/lib/hellosign-ruby-sdk/models/template_response_document_field_group.rb +259 -0
  375. data/lib/hellosign-ruby-sdk/models/template_response_document_form_field.rb +416 -0
  376. data/lib/hellosign-ruby-sdk/models/template_response_document_static_field.rb +340 -0
  377. data/lib/hellosign-ruby-sdk/models/template_response_field_avg_text_length.rb +260 -0
  378. data/lib/hellosign-ruby-sdk/models/template_response_named_form_field.rb +382 -0
  379. data/lib/hellosign-ruby-sdk/models/template_response_signer_role.rb +259 -0
  380. data/lib/hellosign-ruby-sdk/models/template_update_files_request.rb +335 -0
  381. data/lib/hellosign-ruby-sdk/models/template_update_files_response.rb +248 -0
  382. data/lib/hellosign-ruby-sdk/models/template_update_files_response_template.rb +262 -0
  383. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_embedded_request.rb +716 -0
  384. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_embedded_with_template_request.rb +630 -0
  385. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_request.rb +574 -0
  386. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_create_response.rb +260 -0
  387. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_edit_and_resend_request.rb +327 -0
  388. data/lib/hellosign-ruby-sdk/models/unclaimed_draft_response.rb +304 -0
  389. data/lib/hellosign-ruby-sdk/models/warning_response.rb +270 -0
  390. data/lib/hellosign-ruby-sdk/version.rb +15 -0
  391. data/lib/hellosign-ruby-sdk.rb +199 -3
  392. data/oas/.editorconfig +6 -0
  393. data/oas/.git +1 -0
  394. data/oas/.github/workflows/github-actions.yml +79 -0
  395. data/oas/.gitignore +2 -0
  396. data/oas/.redocly.lint-ignore.yaml +5 -0
  397. data/oas/.redocly.yaml +11 -0
  398. data/oas/LICENSE +68 -0
  399. data/oas/README.md +107 -0
  400. data/oas/bin/generate-sdk-oas.php +75 -0
  401. data/oas/bin/generate-translated-oas.php +144 -0
  402. data/oas/bin/php +15 -0
  403. data/oas/bin/plugins/decorators/check-for-beta-features.js +68 -0
  404. data/oas/bin/plugins/set-beta-plugin.js +14 -0
  405. data/oas/bin/redoc +17 -0
  406. data/oas/bin/validate +14 -0
  407. data/oas/build +23 -0
  408. data/oas/composer.json +15 -0
  409. data/oas/composer.lock +246 -0
  410. data/oas/examples/AccountCreate.cs +36 -0
  411. data/oas/examples/AccountCreate.java +42 -0
  412. data/oas/examples/AccountCreate.js +21 -0
  413. data/oas/examples/AccountCreate.php +25 -0
  414. data/oas/examples/AccountCreate.py +25 -0
  415. data/oas/examples/AccountCreate.rb +21 -0
  416. data/oas/examples/AccountCreate.ts +21 -0
  417. data/oas/examples/AccountGet.cs +32 -0
  418. data/oas/examples/AccountGet.java +39 -0
  419. data/oas/examples/AccountGet.js +17 -0
  420. data/oas/examples/AccountGet.php +22 -0
  421. data/oas/examples/AccountGet.py +21 -0
  422. data/oas/examples/AccountGet.rb +18 -0
  423. data/oas/examples/AccountGet.ts +17 -0
  424. data/oas/examples/AccountUpdate.cs +36 -0
  425. data/oas/examples/AccountUpdate.java +42 -0
  426. data/oas/examples/AccountUpdate.js +21 -0
  427. data/oas/examples/AccountUpdate.php +25 -0
  428. data/oas/examples/AccountUpdate.py +25 -0
  429. data/oas/examples/AccountUpdate.rb +21 -0
  430. data/oas/examples/AccountUpdate.ts +21 -0
  431. data/oas/examples/AccountVerify.cs +36 -0
  432. data/oas/examples/AccountVerify.java +42 -0
  433. data/oas/examples/AccountVerify.js +21 -0
  434. data/oas/examples/AccountVerify.php +25 -0
  435. data/oas/examples/AccountVerify.py +25 -0
  436. data/oas/examples/AccountVerify.rb +21 -0
  437. data/oas/examples/AccountVerify.ts +21 -0
  438. data/oas/examples/ApiAppCreate.cs +59 -0
  439. data/oas/examples/ApiAppCreate.java +61 -0
  440. data/oas/examples/ApiAppCreate.js +38 -0
  441. data/oas/examples/ApiAppCreate.php +42 -0
  442. data/oas/examples/ApiAppCreate.py +41 -0
  443. data/oas/examples/ApiAppCreate.rb +35 -0
  444. data/oas/examples/ApiAppCreate.ts +38 -0
  445. data/oas/examples/ApiAppDelete.cs +34 -0
  446. data/oas/examples/ApiAppDelete.java +40 -0
  447. data/oas/examples/ApiAppDelete.js +19 -0
  448. data/oas/examples/ApiAppDelete.php +23 -0
  449. data/oas/examples/ApiAppDelete.py +23 -0
  450. data/oas/examples/ApiAppDelete.rb +20 -0
  451. data/oas/examples/ApiAppDelete.ts +19 -0
  452. data/oas/examples/ApiAppGet.cs +34 -0
  453. data/oas/examples/ApiAppGet.java +41 -0
  454. data/oas/examples/ApiAppGet.js +19 -0
  455. data/oas/examples/ApiAppGet.php +24 -0
  456. data/oas/examples/ApiAppGet.py +23 -0
  457. data/oas/examples/ApiAppGet.rb +20 -0
  458. data/oas/examples/ApiAppGet.ts +19 -0
  459. data/oas/examples/ApiAppList.cs +35 -0
  460. data/oas/examples/ApiAppList.java +42 -0
  461. data/oas/examples/ApiAppList.js +20 -0
  462. data/oas/examples/ApiAppList.php +25 -0
  463. data/oas/examples/ApiAppList.py +27 -0
  464. data/oas/examples/ApiAppList.rb +21 -0
  465. data/oas/examples/ApiAppList.ts +20 -0
  466. data/oas/examples/ApiAppUpdate.cs +61 -0
  467. data/oas/examples/ApiAppUpdate.java +63 -0
  468. data/oas/examples/ApiAppUpdate.js +31 -0
  469. data/oas/examples/ApiAppUpdate.php +36 -0
  470. data/oas/examples/ApiAppUpdate.py +37 -0
  471. data/oas/examples/ApiAppUpdate.rb +32 -0
  472. data/oas/examples/ApiAppUpdate.ts +31 -0
  473. data/oas/examples/BulkSendJobGet.cs +35 -0
  474. data/oas/examples/BulkSendJobGet.java +41 -0
  475. data/oas/examples/BulkSendJobGet.js +19 -0
  476. data/oas/examples/BulkSendJobGet.php +24 -0
  477. data/oas/examples/BulkSendJobGet.py +23 -0
  478. data/oas/examples/BulkSendJobGet.rb +20 -0
  479. data/oas/examples/BulkSendJobGet.ts +19 -0
  480. data/oas/examples/BulkSendJobList.cs +36 -0
  481. data/oas/examples/BulkSendJobList.java +42 -0
  482. data/oas/examples/BulkSendJobList.js +20 -0
  483. data/oas/examples/BulkSendJobList.php +25 -0
  484. data/oas/examples/BulkSendJobList.py +27 -0
  485. data/oas/examples/BulkSendJobList.rb +21 -0
  486. data/oas/examples/BulkSendJobList.ts +20 -0
  487. data/oas/examples/EmbeddedEditUrl.cs +40 -0
  488. data/oas/examples/EmbeddedEditUrl.java +47 -0
  489. data/oas/examples/EmbeddedEditUrl.js +24 -0
  490. data/oas/examples/EmbeddedEditUrl.php +28 -0
  491. data/oas/examples/EmbeddedEditUrl.py +28 -0
  492. data/oas/examples/EmbeddedEditUrl.rb +24 -0
  493. data/oas/examples/EmbeddedEditUrl.ts +24 -0
  494. data/oas/examples/EmbeddedSignUrl.cs +35 -0
  495. data/oas/examples/EmbeddedSignUrl.java +44 -0
  496. data/oas/examples/EmbeddedSignUrl.js +19 -0
  497. data/oas/examples/EmbeddedSignUrl.php +24 -0
  498. data/oas/examples/EmbeddedSignUrl.py +23 -0
  499. data/oas/examples/EmbeddedSignUrl.rb +20 -0
  500. data/oas/examples/EmbeddedSignUrl.ts +19 -0
  501. data/oas/examples/OauthTokenGenerate.cs +40 -0
  502. data/oas/examples/OauthTokenGenerate.java +45 -0
  503. data/oas/examples/OauthTokenGenerate.js +23 -0
  504. data/oas/examples/OauthTokenGenerate.php +22 -0
  505. data/oas/examples/OauthTokenGenerate.py +28 -0
  506. data/oas/examples/OauthTokenGenerate.rb +24 -0
  507. data/oas/examples/OauthTokenGenerate.ts +23 -0
  508. data/oas/examples/OauthTokenRefresh.cs +37 -0
  509. data/oas/examples/OauthTokenRefresh.java +42 -0
  510. data/oas/examples/OauthTokenRefresh.js +20 -0
  511. data/oas/examples/OauthTokenRefresh.php +19 -0
  512. data/oas/examples/OauthTokenRefresh.py +25 -0
  513. data/oas/examples/OauthTokenRefresh.rb +21 -0
  514. data/oas/examples/OauthTokenRefresh.ts +20 -0
  515. data/oas/examples/ReportCreate.cs +42 -0
  516. data/oas/examples/ReportCreate.java +47 -0
  517. data/oas/examples/ReportCreate.js +23 -0
  518. data/oas/examples/ReportCreate.php +27 -0
  519. data/oas/examples/ReportCreate.py +27 -0
  520. data/oas/examples/ReportCreate.rb +23 -0
  521. data/oas/examples/ReportCreate.ts +23 -0
  522. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs +82 -0
  523. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java +81 -0
  524. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js +63 -0
  525. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php +60 -0
  526. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py +70 -0
  527. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
  528. data/oas/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts +63 -0
  529. data/oas/examples/SignatureRequestBulkSendWithTemplate.cs +81 -0
  530. data/oas/examples/SignatureRequestBulkSendWithTemplate.java +81 -0
  531. data/oas/examples/SignatureRequestBulkSendWithTemplate.js +65 -0
  532. data/oas/examples/SignatureRequestBulkSendWithTemplate.php +62 -0
  533. data/oas/examples/SignatureRequestBulkSendWithTemplate.py +69 -0
  534. data/oas/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
  535. data/oas/examples/SignatureRequestBulkSendWithTemplate.ts +65 -0
  536. data/oas/examples/SignatureRequestCancel.cs +34 -0
  537. data/oas/examples/SignatureRequestCancel.java +42 -0
  538. data/oas/examples/SignatureRequestCancel.js +19 -0
  539. data/oas/examples/SignatureRequestCancel.php +23 -0
  540. data/oas/examples/SignatureRequestCancel.py +23 -0
  541. data/oas/examples/SignatureRequestCancel.rb +20 -0
  542. data/oas/examples/SignatureRequestCancel.ts +19 -0
  543. data/oas/examples/SignatureRequestCreateEmbedded.cs +64 -0
  544. data/oas/examples/SignatureRequestCreateEmbedded.java +69 -0
  545. data/oas/examples/SignatureRequestCreateEmbedded.js +52 -0
  546. data/oas/examples/SignatureRequestCreateEmbedded.php +53 -0
  547. data/oas/examples/SignatureRequestCreateEmbedded.py +53 -0
  548. data/oas/examples/SignatureRequestCreateEmbedded.rb +46 -0
  549. data/oas/examples/SignatureRequestCreateEmbedded.ts +52 -0
  550. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.cs +55 -0
  551. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.java +51 -0
  552. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.js +41 -0
  553. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.php +43 -0
  554. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.py +45 -0
  555. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
  556. data/oas/examples/SignatureRequestCreateEmbeddedWithTemplate.ts +41 -0
  557. data/oas/examples/SignatureRequestFiles.cs +34 -0
  558. data/oas/examples/SignatureRequestFiles.java +41 -0
  559. data/oas/examples/SignatureRequestFiles.js +19 -0
  560. data/oas/examples/SignatureRequestFiles.php +24 -0
  561. data/oas/examples/SignatureRequestFiles.py +23 -0
  562. data/oas/examples/SignatureRequestFiles.rb +20 -0
  563. data/oas/examples/SignatureRequestFiles.ts +19 -0
  564. data/oas/examples/SignatureRequestGet.cs +34 -0
  565. data/oas/examples/SignatureRequestGet.java +41 -0
  566. data/oas/examples/SignatureRequestGet.js +19 -0
  567. data/oas/examples/SignatureRequestGet.php +24 -0
  568. data/oas/examples/SignatureRequestGet.py +23 -0
  569. data/oas/examples/SignatureRequestGet.rb +20 -0
  570. data/oas/examples/SignatureRequestGet.ts +19 -0
  571. data/oas/examples/SignatureRequestList.cs +34 -0
  572. data/oas/examples/SignatureRequestList.java +41 -0
  573. data/oas/examples/SignatureRequestList.js +20 -0
  574. data/oas/examples/SignatureRequestList.php +25 -0
  575. data/oas/examples/SignatureRequestList.py +27 -0
  576. data/oas/examples/SignatureRequestList.rb +21 -0
  577. data/oas/examples/SignatureRequestList.ts +20 -0
  578. data/oas/examples/SignatureRequestReleaseHold.cs +34 -0
  579. data/oas/examples/SignatureRequestReleaseHold.java +40 -0
  580. data/oas/examples/SignatureRequestReleaseHold.js +19 -0
  581. data/oas/examples/SignatureRequestReleaseHold.php +24 -0
  582. data/oas/examples/SignatureRequestReleaseHold.py +23 -0
  583. data/oas/examples/SignatureRequestReleaseHold.rb +20 -0
  584. data/oas/examples/SignatureRequestReleaseHold.ts +19 -0
  585. data/oas/examples/SignatureRequestRemind.cs +38 -0
  586. data/oas/examples/SignatureRequestRemind.java +43 -0
  587. data/oas/examples/SignatureRequestRemind.js +23 -0
  588. data/oas/examples/SignatureRequestRemind.php +27 -0
  589. data/oas/examples/SignatureRequestRemind.py +27 -0
  590. data/oas/examples/SignatureRequestRemind.rb +23 -0
  591. data/oas/examples/SignatureRequestRemind.ts +23 -0
  592. data/oas/examples/SignatureRequestRemove.cs +33 -0
  593. data/oas/examples/SignatureRequestRemove.java +39 -0
  594. data/oas/examples/SignatureRequestRemove.js +19 -0
  595. data/oas/examples/SignatureRequestRemove.php +20 -0
  596. data/oas/examples/SignatureRequestRemove.py +23 -0
  597. data/oas/examples/SignatureRequestRemove.rb +20 -0
  598. data/oas/examples/SignatureRequestRemove.ts +19 -0
  599. data/oas/examples/SignatureRequestSend.cs +75 -0
  600. data/oas/examples/SignatureRequestSend.java +75 -0
  601. data/oas/examples/SignatureRequestSend.js +60 -0
  602. data/oas/examples/SignatureRequestSend.php +60 -0
  603. data/oas/examples/SignatureRequestSend.py +64 -0
  604. data/oas/examples/SignatureRequestSend.rb +56 -0
  605. data/oas/examples/SignatureRequestSend.ts +60 -0
  606. data/oas/examples/SignatureRequestSendWithTemplate.cs +69 -0
  607. data/oas/examples/SignatureRequestSendWithTemplate.java +75 -0
  608. data/oas/examples/SignatureRequestSendWithTemplate.js +54 -0
  609. data/oas/examples/SignatureRequestSendWithTemplate.php +54 -0
  610. data/oas/examples/SignatureRequestSendWithTemplate.py +58 -0
  611. data/oas/examples/SignatureRequestSendWithTemplate.rb +50 -0
  612. data/oas/examples/SignatureRequestSendWithTemplate.ts +54 -0
  613. data/oas/examples/SignatureRequestUpdate.cs +39 -0
  614. data/oas/examples/SignatureRequestUpdate.java +44 -0
  615. data/oas/examples/SignatureRequestUpdate.js +24 -0
  616. data/oas/examples/SignatureRequestUpdate.php +28 -0
  617. data/oas/examples/SignatureRequestUpdate.py +28 -0
  618. data/oas/examples/SignatureRequestUpdate.rb +24 -0
  619. data/oas/examples/SignatureRequestUpdate.ts +24 -0
  620. data/oas/examples/TeamAddMember.cs +36 -0
  621. data/oas/examples/TeamAddMember.java +41 -0
  622. data/oas/examples/TeamAddMember.js +21 -0
  623. data/oas/examples/TeamAddMember.php +25 -0
  624. data/oas/examples/TeamAddMember.py +25 -0
  625. data/oas/examples/TeamAddMember.rb +21 -0
  626. data/oas/examples/TeamAddMember.ts +21 -0
  627. data/oas/examples/TeamCreate.cs +36 -0
  628. data/oas/examples/TeamCreate.java +41 -0
  629. data/oas/examples/TeamCreate.js +21 -0
  630. data/oas/examples/TeamCreate.php +25 -0
  631. data/oas/examples/TeamCreate.py +25 -0
  632. data/oas/examples/TeamCreate.rb +21 -0
  633. data/oas/examples/TeamCreate.ts +21 -0
  634. data/oas/examples/TeamDelete.cs +31 -0
  635. data/oas/examples/TeamDelete.java +37 -0
  636. data/oas/examples/TeamDelete.js +17 -0
  637. data/oas/examples/TeamDelete.php +21 -0
  638. data/oas/examples/TeamDelete.py +21 -0
  639. data/oas/examples/TeamDelete.rb +18 -0
  640. data/oas/examples/TeamDelete.ts +17 -0
  641. data/oas/examples/TeamGet.cs +32 -0
  642. data/oas/examples/TeamGet.java +38 -0
  643. data/oas/examples/TeamGet.js +17 -0
  644. data/oas/examples/TeamGet.php +22 -0
  645. data/oas/examples/TeamGet.py +21 -0
  646. data/oas/examples/TeamGet.rb +18 -0
  647. data/oas/examples/TeamGet.ts +17 -0
  648. data/oas/examples/TeamInfo.cs +32 -0
  649. data/oas/examples/TeamInfo.java +38 -0
  650. data/oas/examples/TeamInfo.js +17 -0
  651. data/oas/examples/TeamInfo.php +22 -0
  652. data/oas/examples/TeamInfo.py +21 -0
  653. data/oas/examples/TeamInfo.rb +18 -0
  654. data/oas/examples/TeamInfo.ts +17 -0
  655. data/oas/examples/TeamMembers.cs +33 -0
  656. data/oas/examples/TeamMembers.java +40 -0
  657. data/oas/examples/TeamMembers.js +19 -0
  658. data/oas/examples/TeamMembers.php +24 -0
  659. data/oas/examples/TeamMembers.py +23 -0
  660. data/oas/examples/TeamMembers.rb +20 -0
  661. data/oas/examples/TeamMembers.ts +19 -0
  662. data/oas/examples/TeamRemoveMember.cs +37 -0
  663. data/oas/examples/TeamRemoveMember.java +42 -0
  664. data/oas/examples/TeamRemoveMember.js +22 -0
  665. data/oas/examples/TeamRemoveMember.php +26 -0
  666. data/oas/examples/TeamRemoveMember.py +26 -0
  667. data/oas/examples/TeamRemoveMember.rb +22 -0
  668. data/oas/examples/TeamRemoveMember.ts +22 -0
  669. data/oas/examples/TeamSubTeams.cs +33 -0
  670. data/oas/examples/TeamSubTeams.java +40 -0
  671. data/oas/examples/TeamSubTeams.js +19 -0
  672. data/oas/examples/TeamSubTeams.php +24 -0
  673. data/oas/examples/TeamSubTeams.py +23 -0
  674. data/oas/examples/TeamSubTeams.rb +20 -0
  675. data/oas/examples/TeamSubTeams.ts +19 -0
  676. data/oas/examples/TeamUpdate.cs +36 -0
  677. data/oas/examples/TeamUpdate.java +40 -0
  678. data/oas/examples/TeamUpdate.js +21 -0
  679. data/oas/examples/TeamUpdate.php +25 -0
  680. data/oas/examples/TeamUpdate.py +25 -0
  681. data/oas/examples/TeamUpdate.rb +21 -0
  682. data/oas/examples/TeamUpdate.ts +21 -0
  683. data/oas/examples/TemplateAddUser.cs +38 -0
  684. data/oas/examples/TemplateAddUser.java +42 -0
  685. data/oas/examples/TemplateAddUser.js +23 -0
  686. data/oas/examples/TemplateAddUser.php +27 -0
  687. data/oas/examples/TemplateAddUser.py +27 -0
  688. data/oas/examples/TemplateAddUser.rb +23 -0
  689. data/oas/examples/TemplateAddUser.ts +23 -0
  690. data/oas/examples/TemplateCreateEmbeddedDraft.cs +69 -0
  691. data/oas/examples/TemplateCreateEmbeddedDraft.java +70 -0
  692. data/oas/examples/TemplateCreateEmbeddedDraft.js +60 -0
  693. data/oas/examples/TemplateCreateEmbeddedDraft.php +53 -0
  694. data/oas/examples/TemplateCreateEmbeddedDraft.py +58 -0
  695. data/oas/examples/TemplateCreateEmbeddedDraft.rb +49 -0
  696. data/oas/examples/TemplateCreateEmbeddedDraft.ts +60 -0
  697. data/oas/examples/TemplateDelete.cs +33 -0
  698. data/oas/examples/TemplateDelete.java +39 -0
  699. data/oas/examples/TemplateDelete.js +19 -0
  700. data/oas/examples/TemplateDelete.php +23 -0
  701. data/oas/examples/TemplateDelete.py +23 -0
  702. data/oas/examples/TemplateDelete.rb +20 -0
  703. data/oas/examples/TemplateDelete.ts +19 -0
  704. data/oas/examples/TemplateFiles.cs +34 -0
  705. data/oas/examples/TemplateFiles.java +40 -0
  706. data/oas/examples/TemplateFiles.js +19 -0
  707. data/oas/examples/TemplateFiles.php +24 -0
  708. data/oas/examples/TemplateFiles.py +23 -0
  709. data/oas/examples/TemplateFiles.rb +20 -0
  710. data/oas/examples/TemplateFiles.ts +19 -0
  711. data/oas/examples/TemplateGet.cs +34 -0
  712. data/oas/examples/TemplateGet.java +40 -0
  713. data/oas/examples/TemplateGet.js +19 -0
  714. data/oas/examples/TemplateGet.php +24 -0
  715. data/oas/examples/TemplateGet.py +23 -0
  716. data/oas/examples/TemplateGet.rb +20 -0
  717. data/oas/examples/TemplateGet.ts +19 -0
  718. data/oas/examples/TemplateList.cs +34 -0
  719. data/oas/examples/TemplateList.java +40 -0
  720. data/oas/examples/TemplateList.js +19 -0
  721. data/oas/examples/TemplateList.php +24 -0
  722. data/oas/examples/TemplateList.py +25 -0
  723. data/oas/examples/TemplateList.rb +20 -0
  724. data/oas/examples/TemplateList.ts +19 -0
  725. data/oas/examples/TemplateRemoveUser.cs +38 -0
  726. data/oas/examples/TemplateRemoveUser.java +43 -0
  727. data/oas/examples/TemplateRemoveUser.js +23 -0
  728. data/oas/examples/TemplateRemoveUser.php +27 -0
  729. data/oas/examples/TemplateRemoveUser.py +27 -0
  730. data/oas/examples/TemplateRemoveUser.rb +23 -0
  731. data/oas/examples/TemplateRemoveUser.ts +23 -0
  732. data/oas/examples/TemplateUpdateFiles.cs +38 -0
  733. data/oas/examples/TemplateUpdateFiles.java +44 -0
  734. data/oas/examples/TemplateUpdateFiles.js +23 -0
  735. data/oas/examples/TemplateUpdateFiles.php +27 -0
  736. data/oas/examples/TemplateUpdateFiles.py +27 -0
  737. data/oas/examples/TemplateUpdateFiles.rb +23 -0
  738. data/oas/examples/TemplateUpdateFiles.ts +23 -0
  739. data/oas/examples/UnclaimedDraftCreate.cs +75 -0
  740. data/oas/examples/UnclaimedDraftCreate.java +73 -0
  741. data/oas/examples/UnclaimedDraftCreate.js +63 -0
  742. data/oas/examples/UnclaimedDraftCreate.php +60 -0
  743. data/oas/examples/UnclaimedDraftCreate.py +64 -0
  744. data/oas/examples/UnclaimedDraftCreate.rb +56 -0
  745. data/oas/examples/UnclaimedDraftCreate.ts +63 -0
  746. data/oas/examples/UnclaimedDraftCreateEmbedded.cs +39 -0
  747. data/oas/examples/UnclaimedDraftCreateEmbedded.java +46 -0
  748. data/oas/examples/UnclaimedDraftCreateEmbedded.js +24 -0
  749. data/oas/examples/UnclaimedDraftCreateEmbedded.php +28 -0
  750. data/oas/examples/UnclaimedDraftCreateEmbedded.py +28 -0
  751. data/oas/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
  752. data/oas/examples/UnclaimedDraftCreateEmbedded.ts +24 -0
  753. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs +52 -0
  754. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java +58 -0
  755. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.js +37 -0
  756. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.php +39 -0
  757. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py +41 -0
  758. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
  759. data/oas/examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts +37 -0
  760. data/oas/examples/UnclaimedDraftEditAndResend.cs +39 -0
  761. data/oas/examples/UnclaimedDraftEditAndResend.java +44 -0
  762. data/oas/examples/UnclaimedDraftEditAndResend.js +24 -0
  763. data/oas/examples/UnclaimedDraftEditAndResend.php +28 -0
  764. data/oas/examples/UnclaimedDraftEditAndResend.py +28 -0
  765. data/oas/examples/UnclaimedDraftEditAndResend.rb +24 -0
  766. data/oas/examples/UnclaimedDraftEditAndResend.ts +24 -0
  767. data/oas/examples/json/AccountCreateOAuthResponseExample.json +14 -0
  768. data/oas/examples/json/AccountCreateRequestDefaultExample.json +3 -0
  769. data/oas/examples/json/AccountCreateRequestOAuthExample.json +5 -0
  770. data/oas/examples/json/AccountCreateResponseExample.json +18 -0
  771. data/oas/examples/json/AccountGetResponseExample.json +18 -0
  772. data/oas/examples/json/AccountUpdateRequestDefaultExample.json +4 -0
  773. data/oas/examples/json/AccountUpdateResponseExample.json +18 -0
  774. data/oas/examples/json/AccountVerifyFoundResponseExample.json +5 -0
  775. data/oas/examples/json/AccountVerifyNotFoundResponseExample.json +1 -0
  776. data/oas/examples/json/AccountVerifyRequestDefaultExample.json +3 -0
  777. data/oas/examples/json/ApiAppCreateRequestDefaultExample.json +17 -0
  778. data/oas/examples/json/ApiAppCreateRequestFormDataExample.json +18 -0
  779. data/oas/examples/json/ApiAppCreateResponseExample.json +26 -0
  780. data/oas/examples/json/ApiAppGetResponseExample.json +22 -0
  781. data/oas/examples/json/ApiAppListResponseExample.json +43 -0
  782. data/oas/examples/json/ApiAppUpdateRequestDefaultExample.json +8 -0
  783. data/oas/examples/json/ApiAppUpdateRequestFormDataExample.json +9 -0
  784. data/oas/examples/json/ApiAppUpdateResponseExample.json +26 -0
  785. data/oas/examples/json/BulkSendJobGetResponseExample.json +69 -0
  786. data/oas/examples/json/BulkSendJobListResponseExample.json +22 -0
  787. data/oas/examples/json/EmbeddedEditUrlRequestDefaultExample.json +6 -0
  788. data/oas/examples/json/EmbeddedEditUrlResponseExample.json +6 -0
  789. data/oas/examples/json/EmbeddedSignUrlResponseExample.json +6 -0
  790. data/oas/examples/json/Error400ResponseExample.json +7 -0
  791. data/oas/examples/json/Error401ResponseExample.json +6 -0
  792. data/oas/examples/json/Error402ResponseExample.json +6 -0
  793. data/oas/examples/json/Error403ResponseExample.json +6 -0
  794. data/oas/examples/json/Error404ResponseExample.json +6 -0
  795. data/oas/examples/json/Error409ResponseExample.json +6 -0
  796. data/oas/examples/json/Error410ResponseExample.json +6 -0
  797. data/oas/examples/json/Error422ResponseExample.json +6 -0
  798. data/oas/examples/json/Error429ResponseExample.json +6 -0
  799. data/oas/examples/json/Error4XXResponseExample.json +7 -0
  800. data/oas/examples/json/EventCallbackAccountSignatureRequestSentExample.json +51 -0
  801. data/oas/examples/json/EventCallbackAccountTemplateCreatedExample.json +140 -0
  802. data/oas/examples/json/EventCallbackApiAppAccountConfirmedExample.json +28 -0
  803. data/oas/examples/json/EventCallbackApiAppSignatureRequestSentExample.json +51 -0
  804. data/oas/examples/json/EventCallbackApiAppTemplateCreatedExample.json +140 -0
  805. data/oas/examples/json/OAuthTokenGenerateRequestExample.json +7 -0
  806. data/oas/examples/json/OAuthTokenGenerateResponseExample.json +7 -0
  807. data/oas/examples/json/OAuthTokenRefreshRequestExample.json +4 -0
  808. data/oas/examples/json/OAuthTokenRefreshResponseExample.json +6 -0
  809. data/oas/examples/json/ReportCreateRequestDefaultExample.json +8 -0
  810. data/oas/examples/json/ReportCreateResponseExample.json +11 -0
  811. data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json +49 -0
  812. data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json +16 -0
  813. data/oas/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json +8 -0
  814. data/oas/examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json +48 -0
  815. data/oas/examples/json/SignatureRequestBulkSendWithTemplateRequestFormDataExample.json +15 -0
  816. data/oas/examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json +8 -0
  817. data/oas/examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json +33 -0
  818. data/oas/examples/json/SignatureRequestCreateEmbeddedRequestFormDataExample.json +34 -0
  819. data/oas/examples/json/SignatureRequestCreateEmbeddedResponseExample.json +52 -0
  820. data/oas/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json +23 -0
  821. data/oas/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestFormDataExample.json +27 -0
  822. data/oas/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json +45 -0
  823. data/oas/examples/json/SignatureRequestFilesResponseExample.json +4 -0
  824. data/oas/examples/json/SignatureRequestGetResponseExample.json +58 -0
  825. data/oas/examples/json/SignatureRequestListResponseExample.json +112 -0
  826. data/oas/examples/json/SignatureRequestReleaseHoldResponseExample.json +32 -0
  827. data/oas/examples/json/SignatureRequestRemindRequestDefaultExample.json +3 -0
  828. data/oas/examples/json/SignatureRequestRemindResponseExample.json +35 -0
  829. data/oas/examples/json/SignatureRequestSendFormDataExample.json +40 -0
  830. data/oas/examples/json/SignatureRequestSendRequestDefaultExample.json +39 -0
  831. data/oas/examples/json/SignatureRequestSendResponseExample.json +76 -0
  832. data/oas/examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json +36 -0
  833. data/oas/examples/json/SignatureRequestSendWithTemplateRequestFormDataExample.json +40 -0
  834. data/oas/examples/json/SignatureRequestSendWithTemplateResponseExample.json +46 -0
  835. data/oas/examples/json/SignatureRequestUpdateRequestDefaultExample.json +4 -0
  836. data/oas/examples/json/SignatureRequestUpdateResponseExample.json +32 -0
  837. data/oas/examples/json/TeamAddMemberRequestAccountIdExample.json +3 -0
  838. data/oas/examples/json/TeamAddMemberRequestEmailAddressExample.json +3 -0
  839. data/oas/examples/json/TeamAddMemberResponseExample.json +34 -0
  840. data/oas/examples/json/TeamCreateRequestDefaultExample.json +3 -0
  841. data/oas/examples/json/TeamCreateResponseExample.json +21 -0
  842. data/oas/examples/json/TeamDoesNotExistResponseExample.json +6 -0
  843. data/oas/examples/json/TeamGetInfoResponseExample.json +12 -0
  844. data/oas/examples/json/TeamGetResponseExample.json +34 -0
  845. data/oas/examples/json/TeamGetRootInfoResponseExample.json +9 -0
  846. data/oas/examples/json/TeamMembersResponseExample.json +20 -0
  847. data/oas/examples/json/TeamRemoveMemberRequestAccountIdExample.json +3 -0
  848. data/oas/examples/json/TeamRemoveMemberRequestEmailAddressExample.json +4 -0
  849. data/oas/examples/json/TeamRemoveMemberResponseExample.json +21 -0
  850. data/oas/examples/json/TeamSubTeamsResponseExample.json +18 -0
  851. data/oas/examples/json/TeamUpdateRequestDefaultExample.json +3 -0
  852. data/oas/examples/json/TeamUpdateResponseExample.json +21 -0
  853. data/oas/examples/json/TemplateAddUserRequestDefaultExample.json +3 -0
  854. data/oas/examples/json/TemplateAddUserResponseExample.json +202 -0
  855. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json +36 -0
  856. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormDataExample.json +36 -0
  857. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json +75 -0
  858. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json +85 -0
  859. data/oas/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json +66 -0
  860. data/oas/examples/json/TemplateCreateEmbeddedDraftResponseExample.json +7 -0
  861. data/oas/examples/json/TemplateFilesResponseExample.json +4 -0
  862. data/oas/examples/json/TemplateGetResponseExample.json +190 -0
  863. data/oas/examples/json/TemplateListResponseExample.json +263 -0
  864. data/oas/examples/json/TemplateRemoveUserRequestDefaultExample.json +3 -0
  865. data/oas/examples/json/TemplateRemoveUserResponseExample.json +190 -0
  866. data/oas/examples/json/TemplateUpdateFilesRequestDefaultExample.json +5 -0
  867. data/oas/examples/json/TemplateUpdateFilesRequestFormDataExample.json +5 -0
  868. data/oas/examples/json/TemplateUpdateFilesResponseExample.json +5 -0
  869. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json +8 -0
  870. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormDataExample.json +8 -0
  871. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json +47 -0
  872. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json +57 -0
  873. data/oas/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json +38 -0
  874. data/oas/examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json +10 -0
  875. data/oas/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json +21 -0
  876. data/oas/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestFormDataExample.json +24 -0
  877. data/oas/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json +9 -0
  878. data/oas/examples/json/UnclaimedDraftCreateRequestDefaultExample.json +14 -0
  879. data/oas/examples/json/UnclaimedDraftCreateRequestFormDataExample.json +6 -0
  880. data/oas/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json +45 -0
  881. data/oas/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json +55 -0
  882. data/oas/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json +36 -0
  883. data/oas/examples/json/UnclaimedDraftCreateResponseExample.json +8 -0
  884. data/oas/examples/json/UnclaimedDraftEditAndResendExample.json +10 -0
  885. data/oas/examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json +4 -0
  886. data/oas/markdown/en/descriptions/account-callback-description.md +5 -0
  887. data/oas/markdown/en/descriptions/api-app-callback-description.md +5 -0
  888. data/oas/markdown/en/tags/account-tag-description.md +1 -0
  889. data/oas/markdown/en/tags/api-app-tag-description.md +1 -0
  890. data/oas/markdown/en/tags/bulk-send-job-tag-description.md +1 -0
  891. data/oas/markdown/en/tags/callbacks-tag-description.md +7 -0
  892. data/oas/markdown/en/tags/embedded-tag-description.md +1 -0
  893. data/oas/markdown/en/tags/oauth-tag-description.md +20 -0
  894. data/oas/markdown/en/tags/report-tag-description.md +1 -0
  895. data/oas/markdown/en/tags/signature-request-tag-description.md +1 -0
  896. data/oas/markdown/en/tags/team-tag-description.md +1 -0
  897. data/oas/markdown/en/tags/template-tag-description.md +1 -0
  898. data/oas/markdown/en/tags/unclaimed-draft-tag-description.md +1 -0
  899. data/oas/openapi-raw.yaml +9709 -0
  900. data/oas/openapi-sdk.yaml +10206 -0
  901. data/oas/openapi.yaml +10251 -0
  902. data/oas/src/Hello/OpenApi/RawFile.php +220 -0
  903. data/oas/src/Hello/OpenApi/TranslationResult.php +53 -0
  904. data/oas/test_fixtures/AccountCreateRequest.json +7 -0
  905. data/oas/test_fixtures/AccountCreateResponse.json +15 -0
  906. data/oas/test_fixtures/AccountGetResponse.json +14 -0
  907. data/oas/test_fixtures/AccountUpdateRequest.json +5 -0
  908. data/oas/test_fixtures/AccountVerifyRequest.json +5 -0
  909. data/oas/test_fixtures/AccountVerifyResponse.json +7 -0
  910. data/oas/test_fixtures/ApiAppCreateRequest.json +36 -0
  911. data/oas/test_fixtures/ApiAppGetResponse.json +27 -0
  912. data/oas/test_fixtures/ApiAppListResponse.json +42 -0
  913. data/oas/test_fixtures/ApiAppUpdateRequest.json +36 -0
  914. data/oas/test_fixtures/BulkSendJobGetResponse.json +67 -0
  915. data/oas/test_fixtures/BulkSendJobListResponse.json +24 -0
  916. data/oas/test_fixtures/BulkSendJobSendResponse.json +10 -0
  917. data/oas/test_fixtures/EmbeddedEditUrlRequest.json +28 -0
  918. data/oas/test_fixtures/EmbeddedEditUrlResponse.json +8 -0
  919. data/oas/test_fixtures/EmbeddedSignUrlResponse.json +8 -0
  920. data/oas/test_fixtures/ErrorResponse.json +9 -0
  921. data/oas/test_fixtures/EventCallbackHelper.json +50 -0
  922. data/oas/test_fixtures/FileResponse.json +6 -0
  923. data/oas/test_fixtures/OAuthTokenGenerateRequest.json +9 -0
  924. data/oas/test_fixtures/OAuthTokenRefreshRequest.json +6 -0
  925. data/oas/test_fixtures/OAuthTokenResponse.json +15 -0
  926. data/oas/test_fixtures/ReportCreateRequest.json +10 -0
  927. data/oas/test_fixtures/ReportCreateResponse.json +13 -0
  928. data/oas/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +68 -0
  929. data/oas/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +67 -0
  930. data/oas/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +121 -0
  931. data/oas/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +63 -0
  932. data/oas/test_fixtures/SignatureRequestGetResponse.json +146 -0
  933. data/oas/test_fixtures/SignatureRequestListResponse.json +102 -0
  934. data/oas/test_fixtures/SignatureRequestRemindRequest.json +5 -0
  935. data/oas/test_fixtures/SignatureRequestSendRequest.json +271 -0
  936. data/oas/test_fixtures/SignatureRequestSendWithTemplateRequest.json +48 -0
  937. data/oas/test_fixtures/SignatureRequestUpdateRequest.json +7 -0
  938. data/oas/test_fixtures/SubFormFieldsPerDocument.json +107 -0
  939. data/oas/test_fixtures/TeamAddMemberRequest.json +6 -0
  940. data/oas/test_fixtures/TeamCreateRequest.json +5 -0
  941. data/oas/test_fixtures/TeamGetResponse.json +34 -0
  942. data/oas/test_fixtures/TeamRemoveMemberRequest.json +7 -0
  943. data/oas/test_fixtures/TeamUpdateRequest.json +5 -0
  944. data/oas/test_fixtures/TemplateAddUserRequest.json +7 -0
  945. data/oas/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +121 -0
  946. data/oas/test_fixtures/TemplateCreateEmbeddedDraftResponse.json +9 -0
  947. data/oas/test_fixtures/TemplateGetResponse.json +102 -0
  948. data/oas/test_fixtures/TemplateListResponse.json +143 -0
  949. data/oas/test_fixtures/TemplateRemoveUserRequest.json +6 -0
  950. data/oas/test_fixtures/TemplateUpdateFilesRequest.json +14 -0
  951. data/oas/test_fixtures/TemplateUpdateFilesResponse.json +7 -0
  952. data/oas/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +137 -0
  953. data/oas/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +70 -0
  954. data/oas/test_fixtures/UnclaimedDraftCreateRequest.json +122 -0
  955. data/oas/test_fixtures/UnclaimedDraftCreateResponse.json +9 -0
  956. data/oas/test_fixtures/UnclaimedDraftEditAndResendRequest.json +15 -0
  957. data/oas/test_fixtures/pdf-sample-2.pdf +0 -0
  958. data/oas/test_fixtures/pdf-sample.pdf +0 -0
  959. data/oas/translations/en-plugin.json +8 -0
  960. data/oas/translations/en.yaml +1513 -0
  961. data/openapi-config.yaml +21 -0
  962. data/run-build +47 -0
  963. data/spec/api/account_api_spec.rb +110 -0
  964. data/spec/api/api_app_api_spec.rb +94 -0
  965. data/spec/api/bulk_send_job_api_spec.rb +55 -0
  966. data/spec/api/embedded_api_spec.rb +58 -0
  967. data/spec/api/oauth_api_spec.rb +58 -0
  968. data/spec/api/report_api_spec.rb +41 -0
  969. data/spec/api/signature_request_api_spec.rb +265 -0
  970. data/spec/api/team_api_spec.rb +108 -0
  971. data/spec/api/template_api_spec.rb +153 -0
  972. data/spec/api/unclaimed_draft_api_spec.rb +94 -0
  973. data/spec/api_client_spec.rb +226 -0
  974. data/spec/configuration_spec.rb +42 -0
  975. data/spec/event_callback_helper_spec.rb +25 -0
  976. data/spec/fixtures_spec.rb +60 -0
  977. data/spec/models/deserialize_spec.rb +53 -0
  978. data/spec/models/sub_form_fields_per_document_base_spec.rb +30 -0
  979. data/spec/spec_helper.rb +97 -90
  980. data/spec/test_utils.rb +27 -0
  981. data/templates/Gemfile.mustache +10 -0
  982. data/templates/README.mustache +119 -0
  983. data/templates/Rakefile.mustache +10 -0
  984. data/templates/api.mustache +280 -0
  985. data/templates/api_client.mustache +288 -0
  986. data/templates/api_client_faraday_partial.mustache +136 -0
  987. data/templates/api_client_spec.mustache +220 -0
  988. data/templates/api_client_typhoeus_partial.mustache +153 -0
  989. data/templates/api_doc.mustache +77 -0
  990. data/templates/api_error.mustache +49 -0
  991. data/templates/api_info.mustache +12 -0
  992. data/templates/api_test.mustache +47 -0
  993. data/templates/base_object.mustache +146 -0
  994. data/templates/configuration.mustache +383 -0
  995. data/templates/configuration_spec.mustache +34 -0
  996. data/templates/configuration_tls_faraday_partial.mustache +29 -0
  997. data/templates/configuration_tls_typhoeus_partial.mustache +34 -0
  998. data/templates/event_callback_helper.mustache +24 -0
  999. data/templates/gem.mustache +52 -0
  1000. data/templates/gemspec.mustache +35 -0
  1001. data/templates/git_push.sh.mustache +57 -0
  1002. data/templates/gitignore.mustache +41 -0
  1003. data/templates/model.mustache +26 -0
  1004. data/templates/model_doc.mustache +12 -0
  1005. data/templates/model_test.mustache +77 -0
  1006. data/templates/partial_model_enum_class.mustache +20 -0
  1007. data/templates/partial_model_generic.mustache +402 -0
  1008. data/templates/partial_model_generic_doc.mustache +10 -0
  1009. data/templates/partial_oneof_module.mustache +137 -0
  1010. data/templates/partial_oneof_module_doc.mustache +92 -0
  1011. data/templates/rspec.mustache +2 -0
  1012. data/templates/rubocop.mustache +148 -0
  1013. data/templates/spec_helper.mustache +103 -0
  1014. data/templates/travis.mustache +14 -0
  1015. data/templates/version.mustache +7 -0
  1016. data/vendor/autoload.php +7 -0
  1017. data/vendor/bin/yaml-lint +117 -0
  1018. data/vendor/composer/ClassLoader.php +572 -0
  1019. data/vendor/composer/InstalledVersions.php +350 -0
  1020. data/vendor/composer/LICENSE +21 -0
  1021. data/vendor/composer/autoload_classmap.php +10 -0
  1022. data/vendor/composer/autoload_files.php +11 -0
  1023. data/vendor/composer/autoload_namespaces.php +9 -0
  1024. data/vendor/composer/autoload_psr4.php +11 -0
  1025. data/vendor/composer/autoload_real.php +80 -0
  1026. data/vendor/composer/autoload_static.php +46 -0
  1027. data/vendor/composer/installed.json +239 -0
  1028. data/vendor/composer/installed.php +50 -0
  1029. data/vendor/composer/platform_check.php +26 -0
  1030. data/vendor/symfony/deprecation-contracts/.gitignore +3 -0
  1031. data/vendor/symfony/deprecation-contracts/CHANGELOG.md +5 -0
  1032. data/vendor/symfony/deprecation-contracts/LICENSE +19 -0
  1033. data/vendor/symfony/deprecation-contracts/README.md +26 -0
  1034. data/vendor/symfony/deprecation-contracts/composer.json +35 -0
  1035. data/vendor/symfony/deprecation-contracts/function.php +27 -0
  1036. data/vendor/symfony/polyfill-ctype/Ctype.php +232 -0
  1037. data/vendor/symfony/polyfill-ctype/LICENSE +19 -0
  1038. data/vendor/symfony/polyfill-ctype/README.md +12 -0
  1039. data/vendor/symfony/polyfill-ctype/bootstrap.php +50 -0
  1040. data/vendor/symfony/polyfill-ctype/bootstrap80.php +46 -0
  1041. data/vendor/symfony/polyfill-ctype/composer.json +41 -0
  1042. data/vendor/symfony/yaml/CHANGELOG.md +237 -0
  1043. data/vendor/symfony/yaml/Command/LintCommand.php +289 -0
  1044. data/vendor/symfony/yaml/Dumper.php +140 -0
  1045. data/vendor/symfony/yaml/Escaper.php +95 -0
  1046. data/vendor/symfony/yaml/Exception/DumpException.php +21 -0
  1047. data/vendor/symfony/yaml/Exception/ExceptionInterface.php +21 -0
  1048. data/vendor/symfony/yaml/Exception/ParseException.php +132 -0
  1049. data/vendor/symfony/yaml/Exception/RuntimeException.php +21 -0
  1050. data/vendor/symfony/yaml/Inline.php +812 -0
  1051. data/vendor/symfony/yaml/LICENSE +19 -0
  1052. data/vendor/symfony/yaml/Parser.php +1305 -0
  1053. data/vendor/symfony/yaml/README.md +13 -0
  1054. data/vendor/symfony/yaml/Resources/bin/yaml-lint +45 -0
  1055. data/vendor/symfony/yaml/Tag/TaggedValue.php +38 -0
  1056. data/vendor/symfony/yaml/Unescaper.php +132 -0
  1057. data/vendor/symfony/yaml/Yaml.php +100 -0
  1058. data/vendor/symfony/yaml/composer.json +42 -0
  1059. metadata +1092 -182
  1060. data/.gitignore +0 -19
  1061. data/.rspec +0 -2
  1062. data/.travis.yml +0 -15
  1063. data/CONTRIBUTING.md +0 -42
  1064. data/Guardfile +0 -14
  1065. data/lib/hello_sign/.error.rb.swp +0 -0
  1066. data/lib/hello_sign/api/account.rb +0 -78
  1067. data/lib/hello_sign/api/api_app.rb +0 -121
  1068. data/lib/hello_sign/api/bulk_send_job.rb +0 -62
  1069. data/lib/hello_sign/api/embedded.rb +0 -68
  1070. data/lib/hello_sign/api/oauth.rb +0 -95
  1071. data/lib/hello_sign/api/signature_request.rb +0 -662
  1072. data/lib/hello_sign/api/team.rb +0 -107
  1073. data/lib/hello_sign/api/template.rb +0 -227
  1074. data/lib/hello_sign/api/unclaimed_draft.rb +0 -328
  1075. data/lib/hello_sign/api.rb +0 -31
  1076. data/lib/hello_sign/client.rb +0 -369
  1077. data/lib/hello_sign/configuration.rb +0 -78
  1078. data/lib/hello_sign/error.rb +0 -99
  1079. data/lib/hello_sign/resource/account.rb +0 -43
  1080. data/lib/hello_sign/resource/api_app.rb +0 -43
  1081. data/lib/hello_sign/resource/base_resource.rb +0 -73
  1082. data/lib/hello_sign/resource/bulk_send_job.rb +0 -43
  1083. data/lib/hello_sign/resource/embedded.rb +0 -43
  1084. data/lib/hello_sign/resource/resource_array.rb +0 -56
  1085. data/lib/hello_sign/resource/signature_request.rb +0 -43
  1086. data/lib/hello_sign/resource/team.rb +0 -43
  1087. data/lib/hello_sign/resource/template.rb +0 -43
  1088. data/lib/hello_sign/resource/template_draft.rb +0 -44
  1089. data/lib/hello_sign/resource/unclaimed_draft.rb +0 -44
  1090. data/lib/hello_sign/resource.rb +0 -33
  1091. data/lib/hello_sign/version.rb +0 -25
  1092. data/lib/hello_sign.rb +0 -50
  1093. data/spec/fixtures/account.json +0 -15
  1094. data/spec/fixtures/api_app.json +0 -16
  1095. data/spec/fixtures/api_apps.json +0 -43
  1096. data/spec/fixtures/bulk_send_job.json +0 -88
  1097. data/spec/fixtures/bulk_send_jobs.json +0 -22
  1098. data/spec/fixtures/embedded.json +0 -6
  1099. data/spec/fixtures/empty.pdf +0 -0
  1100. data/spec/fixtures/error.json +0 -6
  1101. data/spec/fixtures/headers.json +0 -18
  1102. data/spec/fixtures/nda.pdf +0 -0
  1103. data/spec/fixtures/signature_request.json +0 -45
  1104. data/spec/fixtures/signature_requests.json +0 -44
  1105. data/spec/fixtures/team.json +0 -15
  1106. data/spec/fixtures/template.json +0 -53
  1107. data/spec/fixtures/templates.json +0 -59
  1108. data/spec/fixtures/token.json +0 -14
  1109. data/spec/fixtures/unclaimed_draft.json +0 -6
  1110. data/spec/hello_sign/.error_spec.rb.swp +0 -0
  1111. data/spec/hello_sign/api/account_spec.rb +0 -42
  1112. data/spec/hello_sign/api/api_app_spec.rb +0 -104
  1113. data/spec/hello_sign/api/bulk_send_job_spec.rb +0 -53
  1114. data/spec/hello_sign/api/embedded_spec.rb +0 -23
  1115. data/spec/hello_sign/api/oauth_spec.rb +0 -27
  1116. data/spec/hello_sign/api/signature_request_spec.rb +0 -230
  1117. data/spec/hello_sign/api/team_spec.rb +0 -101
  1118. data/spec/hello_sign/api/template_spec.rb +0 -172
  1119. data/spec/hello_sign/api/unclaimed_draft_spec.rb +0 -145
  1120. data/spec/hello_sign/client_spec.rb +0 -191
  1121. data/spec/hello_sign/error_spec.rb +0 -10
  1122. data/spec/hello_sign/resource/base_resource_spec.rb +0 -53
  1123. data/spec/hello_sign_spec.rb +0 -57
  1124. data/spec/scenarios/uploads_spec.rb +0 -19
@@ -0,0 +1,1435 @@
1
+ =begin
2
+ #HelloSign API
3
+
4
+ #HelloSign 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 HelloSign
16
+ class SignatureRequestApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Embedded Bulk Send with Template
23
+ # Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign. **NOTE**: Only available for Standard plan and higher.
24
+ # @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [BulkSendJobSendResponse]
27
+ def signature_request_bulk_create_embedded_with_template(signature_request_bulk_create_embedded_with_template_request, opts = {})
28
+ data, _status_code, _headers = signature_request_bulk_create_embedded_with_template_with_http_info(signature_request_bulk_create_embedded_with_template_request, opts)
29
+ data
30
+ end
31
+
32
+ # Embedded Bulk Send with Template
33
+ # Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign. **NOTE**: Only available for Standard plan and higher.
34
+ # @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
37
+ def signature_request_bulk_create_embedded_with_template_with_http_info(signature_request_bulk_create_embedded_with_template_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_bulk_create_embedded_with_template ...'
40
+ end
41
+ # verify the required parameter 'signature_request_bulk_create_embedded_with_template_request' is set
42
+ if @api_client.config.client_side_validation && signature_request_bulk_create_embedded_with_template_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'signature_request_bulk_create_embedded_with_template_request' when calling SignatureRequestApi.signature_request_bulk_create_embedded_with_template"
44
+ end
45
+ # resource path
46
+ local_var_path = '/signature_request/bulk_create_embedded_with_template'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
57
+ if !content_type.nil?
58
+ header_params['Content-Type'] = content_type
59
+ end
60
+
61
+ post_body = {}
62
+ form_params = opts[:form_params] || {}
63
+ result = @api_client.generate_form_data(
64
+ signature_request_bulk_create_embedded_with_template_request,
65
+ HelloSign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.openapi_types
66
+ )
67
+
68
+ # form parameters
69
+ if result[:has_file]
70
+ form_params = opts[:form_params] || result[:params]
71
+ header_params['Content-Type'] = 'multipart/form-data'
72
+ else
73
+ # http body (model)
74
+ post_body = opts[:debug_body] || result[:params]
75
+ end
76
+
77
+ # return_type
78
+ return_type = opts[:debug_return_type] || 'BulkSendJobSendResponse'
79
+
80
+ # auth_names
81
+ auth_names = opts[:debug_auth_names] || ['api_key']
82
+
83
+ new_options = opts.merge(
84
+ :operation => :"SignatureRequestApi.signature_request_bulk_create_embedded_with_template",
85
+ :header_params => header_params,
86
+ :query_params => query_params,
87
+ :form_params => form_params,
88
+ :body => post_body,
89
+ :auth_names => auth_names,
90
+ :return_type => return_type
91
+ )
92
+
93
+ begin
94
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
95
+ rescue HelloSign::ApiError => e
96
+ if e.code === 200
97
+ body = @api_client.convert_to_type(
98
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
99
+ "HelloSign::BulkSendJobSendResponse"
100
+ )
101
+
102
+ fail ApiError.new(:code => e.code,
103
+ :response_headers => e.response_headers,
104
+ :response_body => body),
105
+ e.message
106
+ end
107
+
108
+ range_code = "4XX".split('').first
109
+ range_code_left = "#{range_code}00".to_i
110
+ range_code_right = "#{range_code}99".to_i
111
+ if e.code >= range_code_left && e.code <= range_code_right
112
+ body = @api_client.convert_to_type(
113
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
114
+ "HelloSign::ErrorResponse"
115
+ )
116
+
117
+ fail ApiError.new(:code => e.code,
118
+ :response_headers => e.response_headers,
119
+ :response_body => body),
120
+ e.message
121
+ end
122
+
123
+ end
124
+
125
+ if @api_client.config.debugging
126
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_bulk_create_embedded_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
127
+ end
128
+ return data, status_code, headers
129
+ end
130
+
131
+ # Bulk Send with Template
132
+ # Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
133
+ # @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
134
+ # @param [Hash] opts the optional parameters
135
+ # @return [BulkSendJobSendResponse]
136
+ def signature_request_bulk_send_with_template(signature_request_bulk_send_with_template_request, opts = {})
137
+ data, _status_code, _headers = signature_request_bulk_send_with_template_with_http_info(signature_request_bulk_send_with_template_request, opts)
138
+ data
139
+ end
140
+
141
+ # Bulk Send with Template
142
+ # Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the &#x60;template_ids&#x60; parameter. **NOTE**: Only available for Standard plan and higher.
143
+ # @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
144
+ # @param [Hash] opts the optional parameters
145
+ # @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
146
+ def signature_request_bulk_send_with_template_with_http_info(signature_request_bulk_send_with_template_request, opts = {})
147
+ if @api_client.config.debugging
148
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_bulk_send_with_template ...'
149
+ end
150
+ # verify the required parameter 'signature_request_bulk_send_with_template_request' is set
151
+ if @api_client.config.client_side_validation && signature_request_bulk_send_with_template_request.nil?
152
+ fail ArgumentError, "Missing the required parameter 'signature_request_bulk_send_with_template_request' when calling SignatureRequestApi.signature_request_bulk_send_with_template"
153
+ end
154
+ # resource path
155
+ local_var_path = '/signature_request/bulk_send_with_template'
156
+
157
+ # query parameters
158
+ query_params = opts[:query_params] || {}
159
+
160
+ # header parameters
161
+ header_params = opts[:header_params] || {}
162
+ # HTTP header 'Accept' (if needed)
163
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
164
+ # HTTP header 'Content-Type'
165
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
166
+ if !content_type.nil?
167
+ header_params['Content-Type'] = content_type
168
+ end
169
+
170
+ post_body = {}
171
+ form_params = opts[:form_params] || {}
172
+ result = @api_client.generate_form_data(
173
+ signature_request_bulk_send_with_template_request,
174
+ HelloSign::SignatureRequestBulkSendWithTemplateRequest.openapi_types
175
+ )
176
+
177
+ # form parameters
178
+ if result[:has_file]
179
+ form_params = opts[:form_params] || result[:params]
180
+ header_params['Content-Type'] = 'multipart/form-data'
181
+ else
182
+ # http body (model)
183
+ post_body = opts[:debug_body] || result[:params]
184
+ end
185
+
186
+ # return_type
187
+ return_type = opts[:debug_return_type] || 'BulkSendJobSendResponse'
188
+
189
+ # auth_names
190
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
191
+
192
+ new_options = opts.merge(
193
+ :operation => :"SignatureRequestApi.signature_request_bulk_send_with_template",
194
+ :header_params => header_params,
195
+ :query_params => query_params,
196
+ :form_params => form_params,
197
+ :body => post_body,
198
+ :auth_names => auth_names,
199
+ :return_type => return_type
200
+ )
201
+
202
+ begin
203
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
204
+ rescue HelloSign::ApiError => e
205
+ if e.code === 200
206
+ body = @api_client.convert_to_type(
207
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
208
+ "HelloSign::BulkSendJobSendResponse"
209
+ )
210
+
211
+ fail ApiError.new(:code => e.code,
212
+ :response_headers => e.response_headers,
213
+ :response_body => body),
214
+ e.message
215
+ end
216
+
217
+ range_code = "4XX".split('').first
218
+ range_code_left = "#{range_code}00".to_i
219
+ range_code_right = "#{range_code}99".to_i
220
+ if e.code >= range_code_left && e.code <= range_code_right
221
+ body = @api_client.convert_to_type(
222
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
223
+ "HelloSign::ErrorResponse"
224
+ )
225
+
226
+ fail ApiError.new(:code => e.code,
227
+ :response_headers => e.response_headers,
228
+ :response_body => body),
229
+ e.message
230
+ end
231
+
232
+ end
233
+
234
+ if @api_client.config.debugging
235
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_bulk_send_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
236
+ end
237
+ return data, status_code, headers
238
+ end
239
+
240
+ # Cancel Incomplete Signature Request
241
+ # Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
242
+ # @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
243
+ # @param [Hash] opts the optional parameters
244
+ # @return [nil]
245
+ def signature_request_cancel(signature_request_id, opts = {})
246
+ signature_request_cancel_with_http_info(signature_request_id, opts)
247
+ nil
248
+ end
249
+
250
+ # Cancel Incomplete Signature Request
251
+ # Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the &#x60;signature_request_canceled&#x60; event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the &#x60;signature_request_canceled&#x60; event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: &#x60;POST /signature_request/remove/[:signature_request_id]&#x60;.
252
+ # @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
253
+ # @param [Hash] opts the optional parameters
254
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
255
+ def signature_request_cancel_with_http_info(signature_request_id, opts = {})
256
+ if @api_client.config.debugging
257
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_cancel ...'
258
+ end
259
+ # verify the required parameter 'signature_request_id' is set
260
+ if @api_client.config.client_side_validation && signature_request_id.nil?
261
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_cancel"
262
+ end
263
+ # resource path
264
+ local_var_path = '/signature_request/cancel/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
265
+
266
+ # query parameters
267
+ query_params = opts[:query_params] || {}
268
+
269
+ # header parameters
270
+ header_params = opts[:header_params] || {}
271
+ # HTTP header 'Accept' (if needed)
272
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
273
+
274
+ post_body = {}
275
+ form_params = opts[:form_params] || {}
276
+
277
+ # http body (model)
278
+ post_body = opts[:debug_body]
279
+
280
+ # return_type
281
+ return_type = opts[:debug_return_type]
282
+
283
+ # auth_names
284
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
285
+
286
+ new_options = opts.merge(
287
+ :operation => :"SignatureRequestApi.signature_request_cancel",
288
+ :header_params => header_params,
289
+ :query_params => query_params,
290
+ :form_params => form_params,
291
+ :body => post_body,
292
+ :auth_names => auth_names,
293
+ :return_type => return_type
294
+ )
295
+
296
+ begin
297
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
298
+ rescue HelloSign::ApiError => e
299
+ end
300
+
301
+ if @api_client.config.debugging
302
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
303
+ end
304
+ return data, status_code, headers
305
+ end
306
+
307
+ # Create Embedded Signature Request
308
+ # Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
309
+ # @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
310
+ # @param [Hash] opts the optional parameters
311
+ # @return [SignatureRequestGetResponse]
312
+ def signature_request_create_embedded(signature_request_create_embedded_request, opts = {})
313
+ data, _status_code, _headers = signature_request_create_embedded_with_http_info(signature_request_create_embedded_request, opts)
314
+ data
315
+ end
316
+
317
+ # Create Embedded Signature Request
318
+ # Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. &lt;u&gt;Note&lt;/u&gt; that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
319
+ # @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
320
+ # @param [Hash] opts the optional parameters
321
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
322
+ def signature_request_create_embedded_with_http_info(signature_request_create_embedded_request, opts = {})
323
+ if @api_client.config.debugging
324
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_create_embedded ...'
325
+ end
326
+ # verify the required parameter 'signature_request_create_embedded_request' is set
327
+ if @api_client.config.client_side_validation && signature_request_create_embedded_request.nil?
328
+ fail ArgumentError, "Missing the required parameter 'signature_request_create_embedded_request' when calling SignatureRequestApi.signature_request_create_embedded"
329
+ end
330
+ # resource path
331
+ local_var_path = '/signature_request/create_embedded'
332
+
333
+ # query parameters
334
+ query_params = opts[:query_params] || {}
335
+
336
+ # header parameters
337
+ header_params = opts[:header_params] || {}
338
+ # HTTP header 'Accept' (if needed)
339
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
340
+ # HTTP header 'Content-Type'
341
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
342
+ if !content_type.nil?
343
+ header_params['Content-Type'] = content_type
344
+ end
345
+
346
+ post_body = {}
347
+ form_params = opts[:form_params] || {}
348
+ result = @api_client.generate_form_data(
349
+ signature_request_create_embedded_request,
350
+ HelloSign::SignatureRequestCreateEmbeddedRequest.openapi_types
351
+ )
352
+
353
+ # form parameters
354
+ if result[:has_file]
355
+ form_params = opts[:form_params] || result[:params]
356
+ header_params['Content-Type'] = 'multipart/form-data'
357
+ else
358
+ # http body (model)
359
+ post_body = opts[:debug_body] || result[:params]
360
+ end
361
+
362
+ # return_type
363
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
364
+
365
+ # auth_names
366
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
367
+
368
+ new_options = opts.merge(
369
+ :operation => :"SignatureRequestApi.signature_request_create_embedded",
370
+ :header_params => header_params,
371
+ :query_params => query_params,
372
+ :form_params => form_params,
373
+ :body => post_body,
374
+ :auth_names => auth_names,
375
+ :return_type => return_type
376
+ )
377
+
378
+ begin
379
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
380
+ rescue HelloSign::ApiError => e
381
+ if e.code === 200
382
+ body = @api_client.convert_to_type(
383
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
384
+ "HelloSign::SignatureRequestGetResponse"
385
+ )
386
+
387
+ fail ApiError.new(:code => e.code,
388
+ :response_headers => e.response_headers,
389
+ :response_body => body),
390
+ e.message
391
+ end
392
+
393
+ range_code = "4XX".split('').first
394
+ range_code_left = "#{range_code}00".to_i
395
+ range_code_right = "#{range_code}99".to_i
396
+ if e.code >= range_code_left && e.code <= range_code_right
397
+ body = @api_client.convert_to_type(
398
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
399
+ "HelloSign::ErrorResponse"
400
+ )
401
+
402
+ fail ApiError.new(:code => e.code,
403
+ :response_headers => e.response_headers,
404
+ :response_body => body),
405
+ e.message
406
+ end
407
+
408
+ end
409
+
410
+ if @api_client.config.debugging
411
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_create_embedded\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
412
+ end
413
+ return data, status_code, headers
414
+ end
415
+
416
+ # Create Embedded Signature Request with Template
417
+ # Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
418
+ # @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
419
+ # @param [Hash] opts the optional parameters
420
+ # @return [SignatureRequestGetResponse]
421
+ def signature_request_create_embedded_with_template(signature_request_create_embedded_with_template_request, opts = {})
422
+ data, _status_code, _headers = signature_request_create_embedded_with_template_with_http_info(signature_request_create_embedded_with_template_request, opts)
423
+ data
424
+ end
425
+
426
+ # Create Embedded Signature Request with Template
427
+ # Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. &lt;u&gt;Note&lt;/u&gt; that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
428
+ # @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
429
+ # @param [Hash] opts the optional parameters
430
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
431
+ def signature_request_create_embedded_with_template_with_http_info(signature_request_create_embedded_with_template_request, opts = {})
432
+ if @api_client.config.debugging
433
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_create_embedded_with_template ...'
434
+ end
435
+ # verify the required parameter 'signature_request_create_embedded_with_template_request' is set
436
+ if @api_client.config.client_side_validation && signature_request_create_embedded_with_template_request.nil?
437
+ fail ArgumentError, "Missing the required parameter 'signature_request_create_embedded_with_template_request' when calling SignatureRequestApi.signature_request_create_embedded_with_template"
438
+ end
439
+ # resource path
440
+ local_var_path = '/signature_request/create_embedded_with_template'
441
+
442
+ # query parameters
443
+ query_params = opts[:query_params] || {}
444
+
445
+ # header parameters
446
+ header_params = opts[:header_params] || {}
447
+ # HTTP header 'Accept' (if needed)
448
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
449
+ # HTTP header 'Content-Type'
450
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
451
+ if !content_type.nil?
452
+ header_params['Content-Type'] = content_type
453
+ end
454
+
455
+ post_body = {}
456
+ form_params = opts[:form_params] || {}
457
+ result = @api_client.generate_form_data(
458
+ signature_request_create_embedded_with_template_request,
459
+ HelloSign::SignatureRequestCreateEmbeddedWithTemplateRequest.openapi_types
460
+ )
461
+
462
+ # form parameters
463
+ if result[:has_file]
464
+ form_params = opts[:form_params] || result[:params]
465
+ header_params['Content-Type'] = 'multipart/form-data'
466
+ else
467
+ # http body (model)
468
+ post_body = opts[:debug_body] || result[:params]
469
+ end
470
+
471
+ # return_type
472
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
473
+
474
+ # auth_names
475
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
476
+
477
+ new_options = opts.merge(
478
+ :operation => :"SignatureRequestApi.signature_request_create_embedded_with_template",
479
+ :header_params => header_params,
480
+ :query_params => query_params,
481
+ :form_params => form_params,
482
+ :body => post_body,
483
+ :auth_names => auth_names,
484
+ :return_type => return_type
485
+ )
486
+
487
+ begin
488
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
489
+ rescue HelloSign::ApiError => e
490
+ if e.code === 200
491
+ body = @api_client.convert_to_type(
492
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
493
+ "HelloSign::SignatureRequestGetResponse"
494
+ )
495
+
496
+ fail ApiError.new(:code => e.code,
497
+ :response_headers => e.response_headers,
498
+ :response_body => body),
499
+ e.message
500
+ end
501
+
502
+ range_code = "4XX".split('').first
503
+ range_code_left = "#{range_code}00".to_i
504
+ range_code_right = "#{range_code}99".to_i
505
+ if e.code >= range_code_left && e.code <= range_code_right
506
+ body = @api_client.convert_to_type(
507
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
508
+ "HelloSign::ErrorResponse"
509
+ )
510
+
511
+ fail ApiError.new(:code => e.code,
512
+ :response_headers => e.response_headers,
513
+ :response_body => body),
514
+ e.message
515
+ end
516
+
517
+ end
518
+
519
+ if @api_client.config.debugging
520
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_create_embedded_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
521
+ end
522
+ return data, status_code, headers
523
+ end
524
+
525
+ # Download Files
526
+ # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file, or if `get_url` is set, a JSON object with a url to the file (PDFs only). If `get_data_uri` is set, a JSON object with a `data_uri` representing the base64 encoded file (PDFs only) is returned. If the files are currently being prepared, a status code of `409` will be returned instead.
527
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
528
+ # @param [Hash] opts the optional parameters
529
+ # @option opts [String] :file_type Set to &#x60;pdf&#x60; for a single merged document or &#x60;zip&#x60; for a collection of individual documents. (default to 'pdf')
530
+ # @option opts [Boolean] :get_url If &#x60;true&#x60;, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days. (default to false)
531
+ # @option opts [Boolean] :get_data_uri If &#x60;true&#x60;, the response will contain the file as base64 encoded string. Base64 encoding is only available for PDFs. (default to false)
532
+ # @return [FileResponse]
533
+ def signature_request_files(signature_request_id, opts = {})
534
+ data, _status_code, _headers = signature_request_files_with_http_info(signature_request_id, opts)
535
+ data
536
+ end
537
+
538
+ # Download Files
539
+ # Obtain a copy of the current documents specified by the &#x60;signature_request_id&#x60; parameter. Returns a PDF or ZIP file, or if &#x60;get_url&#x60; is set, a JSON object with a url to the file (PDFs only). If &#x60;get_data_uri&#x60; is set, a JSON object with a &#x60;data_uri&#x60; representing the base64 encoded file (PDFs only) is returned. If the files are currently being prepared, a status code of &#x60;409&#x60; will be returned instead.
540
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
541
+ # @param [Hash] opts the optional parameters
542
+ # @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.
543
+ # @option opts [Boolean] :get_url If &#x60;true&#x60;, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days.
544
+ # @option opts [Boolean] :get_data_uri If &#x60;true&#x60;, the response will contain the file as base64 encoded string. Base64 encoding is only available for PDFs.
545
+ # @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
546
+ def signature_request_files_with_http_info(signature_request_id, opts = {})
547
+ if @api_client.config.debugging
548
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_files ...'
549
+ end
550
+ # verify the required parameter 'signature_request_id' is set
551
+ if @api_client.config.client_side_validation && signature_request_id.nil?
552
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_files"
553
+ end
554
+ allowable_values = ["pdf", "zip"]
555
+ if @api_client.config.client_side_validation && opts[:'file_type'] && !allowable_values.include?(opts[:'file_type'])
556
+ fail ArgumentError, "invalid value for \"file_type\", must be one of #{allowable_values}"
557
+ end
558
+ # resource path
559
+ local_var_path = '/signature_request/files/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
560
+
561
+ # query parameters
562
+ query_params = opts[:query_params] || {}
563
+ query_params[:'file_type'] = opts[:'file_type'] if !opts[:'file_type'].nil?
564
+ query_params[:'get_url'] = opts[:'get_url'] if !opts[:'get_url'].nil?
565
+ query_params[:'get_data_uri'] = opts[:'get_data_uri'] if !opts[:'get_data_uri'].nil?
566
+
567
+ # header parameters
568
+ header_params = opts[:header_params] || {}
569
+ # HTTP header 'Accept' (if needed)
570
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
571
+
572
+ post_body = {}
573
+ form_params = opts[:form_params] || {}
574
+
575
+ # http body (model)
576
+ post_body = opts[:debug_body]
577
+
578
+ # return_type
579
+ return_type = opts[:debug_return_type] || 'FileResponse'
580
+
581
+ # auth_names
582
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
583
+
584
+ new_options = opts.merge(
585
+ :operation => :"SignatureRequestApi.signature_request_files",
586
+ :header_params => header_params,
587
+ :query_params => query_params,
588
+ :form_params => form_params,
589
+ :body => post_body,
590
+ :auth_names => auth_names,
591
+ :return_type => return_type
592
+ )
593
+
594
+ begin
595
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
596
+ rescue HelloSign::ApiError => e
597
+ if e.code === 200
598
+ body = @api_client.convert_to_type(
599
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
600
+ "HelloSign::FileResponse"
601
+ )
602
+
603
+ fail ApiError.new(:code => e.code,
604
+ :response_headers => e.response_headers,
605
+ :response_body => body),
606
+ e.message
607
+ end
608
+
609
+ range_code = "4XX".split('').first
610
+ range_code_left = "#{range_code}00".to_i
611
+ range_code_right = "#{range_code}99".to_i
612
+ if e.code >= range_code_left && e.code <= range_code_right
613
+ body = @api_client.convert_to_type(
614
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
615
+ "HelloSign::ErrorResponse"
616
+ )
617
+
618
+ fail ApiError.new(:code => e.code,
619
+ :response_headers => e.response_headers,
620
+ :response_body => body),
621
+ e.message
622
+ end
623
+
624
+ end
625
+
626
+ if @api_client.config.debugging
627
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
628
+ end
629
+ return data, status_code, headers
630
+ end
631
+
632
+ # Get Signature Request
633
+ # Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
634
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
635
+ # @param [Hash] opts the optional parameters
636
+ # @return [SignatureRequestGetResponse]
637
+ def signature_request_get(signature_request_id, opts = {})
638
+ data, _status_code, _headers = signature_request_get_with_http_info(signature_request_id, opts)
639
+ data
640
+ end
641
+
642
+ # Get Signature Request
643
+ # Returns the status of the SignatureRequest specified by the &#x60;signature_request_id&#x60; parameter.
644
+ # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
645
+ # @param [Hash] opts the optional parameters
646
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
647
+ def signature_request_get_with_http_info(signature_request_id, opts = {})
648
+ if @api_client.config.debugging
649
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_get ...'
650
+ end
651
+ # verify the required parameter 'signature_request_id' is set
652
+ if @api_client.config.client_side_validation && signature_request_id.nil?
653
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_get"
654
+ end
655
+ # resource path
656
+ local_var_path = '/signature_request/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
657
+
658
+ # query parameters
659
+ query_params = opts[:query_params] || {}
660
+
661
+ # header parameters
662
+ header_params = opts[:header_params] || {}
663
+ # HTTP header 'Accept' (if needed)
664
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
665
+
666
+ post_body = {}
667
+ form_params = opts[:form_params] || {}
668
+
669
+ # http body (model)
670
+ post_body = opts[:debug_body]
671
+
672
+ # return_type
673
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
674
+
675
+ # auth_names
676
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
677
+
678
+ new_options = opts.merge(
679
+ :operation => :"SignatureRequestApi.signature_request_get",
680
+ :header_params => header_params,
681
+ :query_params => query_params,
682
+ :form_params => form_params,
683
+ :body => post_body,
684
+ :auth_names => auth_names,
685
+ :return_type => return_type
686
+ )
687
+
688
+ begin
689
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
690
+ rescue HelloSign::ApiError => e
691
+ if e.code === 200
692
+ body = @api_client.convert_to_type(
693
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
694
+ "HelloSign::SignatureRequestGetResponse"
695
+ )
696
+
697
+ fail ApiError.new(:code => e.code,
698
+ :response_headers => e.response_headers,
699
+ :response_body => body),
700
+ e.message
701
+ end
702
+
703
+ range_code = "4XX".split('').first
704
+ range_code_left = "#{range_code}00".to_i
705
+ range_code_right = "#{range_code}99".to_i
706
+ if e.code >= range_code_left && e.code <= range_code_right
707
+ body = @api_client.convert_to_type(
708
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
709
+ "HelloSign::ErrorResponse"
710
+ )
711
+
712
+ fail ApiError.new(:code => e.code,
713
+ :response_headers => e.response_headers,
714
+ :response_body => body),
715
+ e.message
716
+ end
717
+
718
+ end
719
+
720
+ if @api_client.config.debugging
721
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
722
+ end
723
+ return data, status_code, headers
724
+ end
725
+
726
+ # List Signature Requests
727
+ # Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
728
+ # @param [Hash] opts the optional parameters
729
+ # @option opts [String] :account_id Which account to return SignatureRequests for. Must be a team member. Use &#x60;all&#x60; to indicate all team members. Defaults to your account.
730
+ # @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to &#x60;1&#x60;. (default to 1)
731
+ # @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)
732
+ # @option opts [String] :query String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
733
+ # @return [SignatureRequestListResponse]
734
+ def signature_request_list(opts = {})
735
+ data, _status_code, _headers = signature_request_list_with_http_info(opts)
736
+ data
737
+ end
738
+
739
+ # List Signature Requests
740
+ # Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
741
+ # @param [Hash] opts the optional parameters
742
+ # @option opts [String] :account_id Which account to return SignatureRequests for. Must be a team member. Use &#x60;all&#x60; to indicate all team members. Defaults to your account.
743
+ # @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to &#x60;1&#x60;.
744
+ # @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;.
745
+ # @option opts [String] :query String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
746
+ # @return [Array<(SignatureRequestListResponse, Integer, Hash)>] SignatureRequestListResponse data, response status code and response headers
747
+ def signature_request_list_with_http_info(opts = {})
748
+ if @api_client.config.debugging
749
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_list ...'
750
+ end
751
+ # resource path
752
+ local_var_path = '/signature_request/list'
753
+
754
+ # query parameters
755
+ query_params = opts[:query_params] || {}
756
+ query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
757
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
758
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
759
+ query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
760
+
761
+ # header parameters
762
+ header_params = opts[:header_params] || {}
763
+ # HTTP header 'Accept' (if needed)
764
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
765
+
766
+ post_body = {}
767
+ form_params = opts[:form_params] || {}
768
+
769
+ # http body (model)
770
+ post_body = opts[:debug_body]
771
+
772
+ # return_type
773
+ return_type = opts[:debug_return_type] || 'SignatureRequestListResponse'
774
+
775
+ # auth_names
776
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
777
+
778
+ new_options = opts.merge(
779
+ :operation => :"SignatureRequestApi.signature_request_list",
780
+ :header_params => header_params,
781
+ :query_params => query_params,
782
+ :form_params => form_params,
783
+ :body => post_body,
784
+ :auth_names => auth_names,
785
+ :return_type => return_type
786
+ )
787
+
788
+ begin
789
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
790
+ rescue HelloSign::ApiError => e
791
+ if e.code === 200
792
+ body = @api_client.convert_to_type(
793
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
794
+ "HelloSign::SignatureRequestListResponse"
795
+ )
796
+
797
+ fail ApiError.new(:code => e.code,
798
+ :response_headers => e.response_headers,
799
+ :response_body => body),
800
+ e.message
801
+ end
802
+
803
+ range_code = "4XX".split('').first
804
+ range_code_left = "#{range_code}00".to_i
805
+ range_code_right = "#{range_code}99".to_i
806
+ if e.code >= range_code_left && e.code <= range_code_right
807
+ body = @api_client.convert_to_type(
808
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
809
+ "HelloSign::ErrorResponse"
810
+ )
811
+
812
+ fail ApiError.new(:code => e.code,
813
+ :response_headers => e.response_headers,
814
+ :response_body => body),
815
+ e.message
816
+ end
817
+
818
+ end
819
+
820
+ if @api_client.config.debugging
821
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
822
+ end
823
+ return data, status_code, headers
824
+ end
825
+
826
+ # Release On-Hold Signature Request
827
+ # Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.
828
+ # @param signature_request_id [String] The id of the SignatureRequest to release.
829
+ # @param [Hash] opts the optional parameters
830
+ # @return [SignatureRequestGetResponse]
831
+ def signature_request_release_hold(signature_request_id, opts = {})
832
+ data, _status_code, _headers = signature_request_release_hold_with_http_info(signature_request_id, opts)
833
+ data
834
+ end
835
+
836
+ # Release On-Hold Signature Request
837
+ # Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.
838
+ # @param signature_request_id [String] The id of the SignatureRequest to release.
839
+ # @param [Hash] opts the optional parameters
840
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
841
+ def signature_request_release_hold_with_http_info(signature_request_id, opts = {})
842
+ if @api_client.config.debugging
843
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_release_hold ...'
844
+ end
845
+ # verify the required parameter 'signature_request_id' is set
846
+ if @api_client.config.client_side_validation && signature_request_id.nil?
847
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_release_hold"
848
+ end
849
+ # resource path
850
+ local_var_path = '/signature_request/release_hold/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
851
+
852
+ # query parameters
853
+ query_params = opts[:query_params] || {}
854
+
855
+ # header parameters
856
+ header_params = opts[:header_params] || {}
857
+ # HTTP header 'Accept' (if needed)
858
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
859
+
860
+ post_body = {}
861
+ form_params = opts[:form_params] || {}
862
+
863
+ # http body (model)
864
+ post_body = opts[:debug_body]
865
+
866
+ # return_type
867
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
868
+
869
+ # auth_names
870
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
871
+
872
+ new_options = opts.merge(
873
+ :operation => :"SignatureRequestApi.signature_request_release_hold",
874
+ :header_params => header_params,
875
+ :query_params => query_params,
876
+ :form_params => form_params,
877
+ :body => post_body,
878
+ :auth_names => auth_names,
879
+ :return_type => return_type
880
+ )
881
+
882
+ begin
883
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
884
+ rescue HelloSign::ApiError => e
885
+ if e.code === 200
886
+ body = @api_client.convert_to_type(
887
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
888
+ "HelloSign::SignatureRequestGetResponse"
889
+ )
890
+
891
+ fail ApiError.new(:code => e.code,
892
+ :response_headers => e.response_headers,
893
+ :response_body => body),
894
+ e.message
895
+ end
896
+
897
+ range_code = "4XX".split('').first
898
+ range_code_left = "#{range_code}00".to_i
899
+ range_code_right = "#{range_code}99".to_i
900
+ if e.code >= range_code_left && e.code <= range_code_right
901
+ body = @api_client.convert_to_type(
902
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
903
+ "HelloSign::ErrorResponse"
904
+ )
905
+
906
+ fail ApiError.new(:code => e.code,
907
+ :response_headers => e.response_headers,
908
+ :response_body => body),
909
+ e.message
910
+ end
911
+
912
+ end
913
+
914
+ if @api_client.config.debugging
915
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_release_hold\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
916
+ end
917
+ return data, status_code, headers
918
+ end
919
+
920
+ # Send Request Reminder
921
+ # Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE**: This action can **not** be used with embedded signature requests.
922
+ # @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
923
+ # @param signature_request_remind_request [SignatureRequestRemindRequest]
924
+ # @param [Hash] opts the optional parameters
925
+ # @return [SignatureRequestGetResponse]
926
+ def signature_request_remind(signature_request_id, signature_request_remind_request, opts = {})
927
+ data, _status_code, _headers = signature_request_remind_with_http_info(signature_request_id, signature_request_remind_request, opts)
928
+ data
929
+ end
930
+
931
+ # Send Request Reminder
932
+ # Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE**: This action can **not** be used with embedded signature requests.
933
+ # @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
934
+ # @param signature_request_remind_request [SignatureRequestRemindRequest]
935
+ # @param [Hash] opts the optional parameters
936
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
937
+ def signature_request_remind_with_http_info(signature_request_id, signature_request_remind_request, opts = {})
938
+ if @api_client.config.debugging
939
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_remind ...'
940
+ end
941
+ # verify the required parameter 'signature_request_id' is set
942
+ if @api_client.config.client_side_validation && signature_request_id.nil?
943
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_remind"
944
+ end
945
+ # verify the required parameter 'signature_request_remind_request' is set
946
+ if @api_client.config.client_side_validation && signature_request_remind_request.nil?
947
+ fail ArgumentError, "Missing the required parameter 'signature_request_remind_request' when calling SignatureRequestApi.signature_request_remind"
948
+ end
949
+ # resource path
950
+ local_var_path = '/signature_request/remind/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
951
+
952
+ # query parameters
953
+ query_params = opts[:query_params] || {}
954
+
955
+ # header parameters
956
+ header_params = opts[:header_params] || {}
957
+ # HTTP header 'Accept' (if needed)
958
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
959
+ # HTTP header 'Content-Type'
960
+ content_type = @api_client.select_header_content_type(['application/json'])
961
+ if !content_type.nil?
962
+ header_params['Content-Type'] = content_type
963
+ end
964
+
965
+ post_body = {}
966
+ form_params = opts[:form_params] || {}
967
+ result = @api_client.generate_form_data(
968
+ signature_request_remind_request,
969
+ HelloSign::SignatureRequestRemindRequest.openapi_types
970
+ )
971
+
972
+ # form parameters
973
+ if result[:has_file]
974
+ form_params = opts[:form_params] || result[:params]
975
+ header_params['Content-Type'] = 'multipart/form-data'
976
+ else
977
+ # http body (model)
978
+ post_body = opts[:debug_body] || result[:params]
979
+ end
980
+
981
+ # return_type
982
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
983
+
984
+ # auth_names
985
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
986
+
987
+ new_options = opts.merge(
988
+ :operation => :"SignatureRequestApi.signature_request_remind",
989
+ :header_params => header_params,
990
+ :query_params => query_params,
991
+ :form_params => form_params,
992
+ :body => post_body,
993
+ :auth_names => auth_names,
994
+ :return_type => return_type
995
+ )
996
+
997
+ begin
998
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
999
+ rescue HelloSign::ApiError => e
1000
+ if e.code === 200
1001
+ body = @api_client.convert_to_type(
1002
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1003
+ "HelloSign::SignatureRequestGetResponse"
1004
+ )
1005
+
1006
+ fail ApiError.new(:code => e.code,
1007
+ :response_headers => e.response_headers,
1008
+ :response_body => body),
1009
+ e.message
1010
+ end
1011
+
1012
+ range_code = "4XX".split('').first
1013
+ range_code_left = "#{range_code}00".to_i
1014
+ range_code_right = "#{range_code}99".to_i
1015
+ if e.code >= range_code_left && e.code <= range_code_right
1016
+ body = @api_client.convert_to_type(
1017
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1018
+ "HelloSign::ErrorResponse"
1019
+ )
1020
+
1021
+ fail ApiError.new(:code => e.code,
1022
+ :response_headers => e.response_headers,
1023
+ :response_body => body),
1024
+ e.message
1025
+ end
1026
+
1027
+ end
1028
+
1029
+ if @api_client.config.debugging
1030
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_remind\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1031
+ end
1032
+ return data, status_code, headers
1033
+ end
1034
+
1035
+ # Remove Signature Request Access
1036
+ # Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
1037
+ # @param signature_request_id [String] The id of the SignatureRequest to remove.
1038
+ # @param [Hash] opts the optional parameters
1039
+ # @return [nil]
1040
+ def signature_request_remove(signature_request_id, opts = {})
1041
+ signature_request_remove_with_http_info(signature_request_id, opts)
1042
+ nil
1043
+ end
1044
+
1045
+ # Remove Signature Request Access
1046
+ # Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
1047
+ # @param signature_request_id [String] The id of the SignatureRequest to remove.
1048
+ # @param [Hash] opts the optional parameters
1049
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1050
+ def signature_request_remove_with_http_info(signature_request_id, opts = {})
1051
+ if @api_client.config.debugging
1052
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_remove ...'
1053
+ end
1054
+ # verify the required parameter 'signature_request_id' is set
1055
+ if @api_client.config.client_side_validation && signature_request_id.nil?
1056
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_remove"
1057
+ end
1058
+ # resource path
1059
+ local_var_path = '/signature_request/remove/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
1060
+
1061
+ # query parameters
1062
+ query_params = opts[:query_params] || {}
1063
+
1064
+ # header parameters
1065
+ header_params = opts[:header_params] || {}
1066
+ # HTTP header 'Accept' (if needed)
1067
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1068
+
1069
+ post_body = {}
1070
+ form_params = opts[:form_params] || {}
1071
+
1072
+ # http body (model)
1073
+ post_body = opts[:debug_body]
1074
+
1075
+ # return_type
1076
+ return_type = opts[:debug_return_type]
1077
+
1078
+ # auth_names
1079
+ auth_names = opts[:debug_auth_names] || ['api_key']
1080
+
1081
+ new_options = opts.merge(
1082
+ :operation => :"SignatureRequestApi.signature_request_remove",
1083
+ :header_params => header_params,
1084
+ :query_params => query_params,
1085
+ :form_params => form_params,
1086
+ :body => post_body,
1087
+ :auth_names => auth_names,
1088
+ :return_type => return_type
1089
+ )
1090
+
1091
+ begin
1092
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1093
+ rescue HelloSign::ApiError => e
1094
+ end
1095
+
1096
+ if @api_client.config.debugging
1097
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1098
+ end
1099
+ return data, status_code, headers
1100
+ end
1101
+
1102
+ # Send Signature Request
1103
+ # Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
1104
+ # @param signature_request_send_request [SignatureRequestSendRequest]
1105
+ # @param [Hash] opts the optional parameters
1106
+ # @return [SignatureRequestGetResponse]
1107
+ def signature_request_send(signature_request_send_request, opts = {})
1108
+ data, _status_code, _headers = signature_request_send_with_http_info(signature_request_send_request, opts)
1109
+ data
1110
+ end
1111
+
1112
+ # Send Signature Request
1113
+ # Creates and sends a new SignatureRequest with the submitted documents. If &#x60;form_fields_per_document&#x60; is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
1114
+ # @param signature_request_send_request [SignatureRequestSendRequest]
1115
+ # @param [Hash] opts the optional parameters
1116
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
1117
+ def signature_request_send_with_http_info(signature_request_send_request, opts = {})
1118
+ if @api_client.config.debugging
1119
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_send ...'
1120
+ end
1121
+ # verify the required parameter 'signature_request_send_request' is set
1122
+ if @api_client.config.client_side_validation && signature_request_send_request.nil?
1123
+ fail ArgumentError, "Missing the required parameter 'signature_request_send_request' when calling SignatureRequestApi.signature_request_send"
1124
+ end
1125
+ # resource path
1126
+ local_var_path = '/signature_request/send'
1127
+
1128
+ # query parameters
1129
+ query_params = opts[:query_params] || {}
1130
+
1131
+ # header parameters
1132
+ header_params = opts[:header_params] || {}
1133
+ # HTTP header 'Accept' (if needed)
1134
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1135
+ # HTTP header 'Content-Type'
1136
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
1137
+ if !content_type.nil?
1138
+ header_params['Content-Type'] = content_type
1139
+ end
1140
+
1141
+ post_body = {}
1142
+ form_params = opts[:form_params] || {}
1143
+ result = @api_client.generate_form_data(
1144
+ signature_request_send_request,
1145
+ HelloSign::SignatureRequestSendRequest.openapi_types
1146
+ )
1147
+
1148
+ # form parameters
1149
+ if result[:has_file]
1150
+ form_params = opts[:form_params] || result[:params]
1151
+ header_params['Content-Type'] = 'multipart/form-data'
1152
+ else
1153
+ # http body (model)
1154
+ post_body = opts[:debug_body] || result[:params]
1155
+ end
1156
+
1157
+ # return_type
1158
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
1159
+
1160
+ # auth_names
1161
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
1162
+
1163
+ new_options = opts.merge(
1164
+ :operation => :"SignatureRequestApi.signature_request_send",
1165
+ :header_params => header_params,
1166
+ :query_params => query_params,
1167
+ :form_params => form_params,
1168
+ :body => post_body,
1169
+ :auth_names => auth_names,
1170
+ :return_type => return_type
1171
+ )
1172
+
1173
+ begin
1174
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1175
+ rescue HelloSign::ApiError => e
1176
+ if e.code === 200
1177
+ body = @api_client.convert_to_type(
1178
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1179
+ "HelloSign::SignatureRequestGetResponse"
1180
+ )
1181
+
1182
+ fail ApiError.new(:code => e.code,
1183
+ :response_headers => e.response_headers,
1184
+ :response_body => body),
1185
+ e.message
1186
+ end
1187
+
1188
+ range_code = "4XX".split('').first
1189
+ range_code_left = "#{range_code}00".to_i
1190
+ range_code_right = "#{range_code}99".to_i
1191
+ if e.code >= range_code_left && e.code <= range_code_right
1192
+ body = @api_client.convert_to_type(
1193
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1194
+ "HelloSign::ErrorResponse"
1195
+ )
1196
+
1197
+ fail ApiError.new(:code => e.code,
1198
+ :response_headers => e.response_headers,
1199
+ :response_body => body),
1200
+ e.message
1201
+ end
1202
+
1203
+ end
1204
+
1205
+ if @api_client.config.debugging
1206
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1207
+ end
1208
+ return data, status_code, headers
1209
+ end
1210
+
1211
+ # Send with Template
1212
+ # Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.
1213
+ # @param signature_request_send_with_template_request [SignatureRequestSendWithTemplateRequest]
1214
+ # @param [Hash] opts the optional parameters
1215
+ # @return [SignatureRequestGetResponse]
1216
+ def signature_request_send_with_template(signature_request_send_with_template_request, opts = {})
1217
+ data, _status_code, _headers = signature_request_send_with_template_with_http_info(signature_request_send_with_template_request, opts)
1218
+ data
1219
+ end
1220
+
1221
+ # Send with Template
1222
+ # Creates and sends a new SignatureRequest based off of the Template(s) specified with the &#x60;template_ids&#x60; parameter.
1223
+ # @param signature_request_send_with_template_request [SignatureRequestSendWithTemplateRequest]
1224
+ # @param [Hash] opts the optional parameters
1225
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
1226
+ def signature_request_send_with_template_with_http_info(signature_request_send_with_template_request, opts = {})
1227
+ if @api_client.config.debugging
1228
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_send_with_template ...'
1229
+ end
1230
+ # verify the required parameter 'signature_request_send_with_template_request' is set
1231
+ if @api_client.config.client_side_validation && signature_request_send_with_template_request.nil?
1232
+ fail ArgumentError, "Missing the required parameter 'signature_request_send_with_template_request' when calling SignatureRequestApi.signature_request_send_with_template"
1233
+ end
1234
+ # resource path
1235
+ local_var_path = '/signature_request/send_with_template'
1236
+
1237
+ # query parameters
1238
+ query_params = opts[:query_params] || {}
1239
+
1240
+ # header parameters
1241
+ header_params = opts[:header_params] || {}
1242
+ # HTTP header 'Accept' (if needed)
1243
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1244
+ # HTTP header 'Content-Type'
1245
+ content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
1246
+ if !content_type.nil?
1247
+ header_params['Content-Type'] = content_type
1248
+ end
1249
+
1250
+ post_body = {}
1251
+ form_params = opts[:form_params] || {}
1252
+ result = @api_client.generate_form_data(
1253
+ signature_request_send_with_template_request,
1254
+ HelloSign::SignatureRequestSendWithTemplateRequest.openapi_types
1255
+ )
1256
+
1257
+ # form parameters
1258
+ if result[:has_file]
1259
+ form_params = opts[:form_params] || result[:params]
1260
+ header_params['Content-Type'] = 'multipart/form-data'
1261
+ else
1262
+ # http body (model)
1263
+ post_body = opts[:debug_body] || result[:params]
1264
+ end
1265
+
1266
+ # return_type
1267
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
1268
+
1269
+ # auth_names
1270
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
1271
+
1272
+ new_options = opts.merge(
1273
+ :operation => :"SignatureRequestApi.signature_request_send_with_template",
1274
+ :header_params => header_params,
1275
+ :query_params => query_params,
1276
+ :form_params => form_params,
1277
+ :body => post_body,
1278
+ :auth_names => auth_names,
1279
+ :return_type => return_type
1280
+ )
1281
+
1282
+ begin
1283
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1284
+ rescue HelloSign::ApiError => e
1285
+ if e.code === 200
1286
+ body = @api_client.convert_to_type(
1287
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1288
+ "HelloSign::SignatureRequestGetResponse"
1289
+ )
1290
+
1291
+ fail ApiError.new(:code => e.code,
1292
+ :response_headers => e.response_headers,
1293
+ :response_body => body),
1294
+ e.message
1295
+ end
1296
+
1297
+ range_code = "4XX".split('').first
1298
+ range_code_left = "#{range_code}00".to_i
1299
+ range_code_right = "#{range_code}99".to_i
1300
+ if e.code >= range_code_left && e.code <= range_code_right
1301
+ body = @api_client.convert_to_type(
1302
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1303
+ "HelloSign::ErrorResponse"
1304
+ )
1305
+
1306
+ fail ApiError.new(:code => e.code,
1307
+ :response_headers => e.response_headers,
1308
+ :response_body => body),
1309
+ e.message
1310
+ end
1311
+
1312
+ end
1313
+
1314
+ if @api_client.config.debugging
1315
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_send_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1316
+ end
1317
+ return data, status_code, headers
1318
+ end
1319
+
1320
+ # Update Signature Request
1321
+ # Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
1322
+ # @param signature_request_id [String] The id of the SignatureRequest to update.
1323
+ # @param signature_request_update_request [SignatureRequestUpdateRequest]
1324
+ # @param [Hash] opts the optional parameters
1325
+ # @return [SignatureRequestGetResponse]
1326
+ def signature_request_update(signature_request_id, signature_request_update_request, opts = {})
1327
+ data, _status_code, _headers = signature_request_update_with_http_info(signature_request_id, signature_request_update_request, opts)
1328
+ data
1329
+ end
1330
+
1331
+ # Update Signature Request
1332
+ # Updates the email address and/or the name for a given signer on a signature request. You can listen for the &#x60;signature_request_email_bounce&#x60; event on your app or account to detect bounced emails, and respond with this method. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
1333
+ # @param signature_request_id [String] The id of the SignatureRequest to update.
1334
+ # @param signature_request_update_request [SignatureRequestUpdateRequest]
1335
+ # @param [Hash] opts the optional parameters
1336
+ # @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
1337
+ def signature_request_update_with_http_info(signature_request_id, signature_request_update_request, opts = {})
1338
+ if @api_client.config.debugging
1339
+ @api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_update ...'
1340
+ end
1341
+ # verify the required parameter 'signature_request_id' is set
1342
+ if @api_client.config.client_side_validation && signature_request_id.nil?
1343
+ fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_update"
1344
+ end
1345
+ # verify the required parameter 'signature_request_update_request' is set
1346
+ if @api_client.config.client_side_validation && signature_request_update_request.nil?
1347
+ fail ArgumentError, "Missing the required parameter 'signature_request_update_request' when calling SignatureRequestApi.signature_request_update"
1348
+ end
1349
+ # resource path
1350
+ local_var_path = '/signature_request/update/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
1351
+
1352
+ # query parameters
1353
+ query_params = opts[:query_params] || {}
1354
+
1355
+ # header parameters
1356
+ header_params = opts[:header_params] || {}
1357
+ # HTTP header 'Accept' (if needed)
1358
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1359
+ # HTTP header 'Content-Type'
1360
+ content_type = @api_client.select_header_content_type(['application/json'])
1361
+ if !content_type.nil?
1362
+ header_params['Content-Type'] = content_type
1363
+ end
1364
+
1365
+ post_body = {}
1366
+ form_params = opts[:form_params] || {}
1367
+ result = @api_client.generate_form_data(
1368
+ signature_request_update_request,
1369
+ HelloSign::SignatureRequestUpdateRequest.openapi_types
1370
+ )
1371
+
1372
+ # form parameters
1373
+ if result[:has_file]
1374
+ form_params = opts[:form_params] || result[:params]
1375
+ header_params['Content-Type'] = 'multipart/form-data'
1376
+ else
1377
+ # http body (model)
1378
+ post_body = opts[:debug_body] || result[:params]
1379
+ end
1380
+
1381
+ # return_type
1382
+ return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
1383
+
1384
+ # auth_names
1385
+ auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
1386
+
1387
+ new_options = opts.merge(
1388
+ :operation => :"SignatureRequestApi.signature_request_update",
1389
+ :header_params => header_params,
1390
+ :query_params => query_params,
1391
+ :form_params => form_params,
1392
+ :body => post_body,
1393
+ :auth_names => auth_names,
1394
+ :return_type => return_type
1395
+ )
1396
+
1397
+ begin
1398
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1399
+ rescue HelloSign::ApiError => e
1400
+ if e.code === 200
1401
+ body = @api_client.convert_to_type(
1402
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1403
+ "HelloSign::SignatureRequestGetResponse"
1404
+ )
1405
+
1406
+ fail ApiError.new(:code => e.code,
1407
+ :response_headers => e.response_headers,
1408
+ :response_body => body),
1409
+ e.message
1410
+ end
1411
+
1412
+ range_code = "4XX".split('').first
1413
+ range_code_left = "#{range_code}00".to_i
1414
+ range_code_right = "#{range_code}99".to_i
1415
+ if e.code >= range_code_left && e.code <= range_code_right
1416
+ body = @api_client.convert_to_type(
1417
+ JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
1418
+ "HelloSign::ErrorResponse"
1419
+ )
1420
+
1421
+ fail ApiError.new(:code => e.code,
1422
+ :response_headers => e.response_headers,
1423
+ :response_body => body),
1424
+ e.message
1425
+ end
1426
+
1427
+ end
1428
+
1429
+ if @api_client.config.debugging
1430
+ @api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1431
+ end
1432
+ return data, status_code, headers
1433
+ end
1434
+ end
1435
+ end