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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1119) hide show
  1. checksums.yaml +5 -5
  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 -92
  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 -174
  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 -91
  1067. data/lib/hello_sign/api/api_app.rb +0 -119
  1068. data/lib/hello_sign/api/embedded.rb +0 -74
  1069. data/lib/hello_sign/api/oauth.rb +0 -103
  1070. data/lib/hello_sign/api/signature_request.rb +0 -479
  1071. data/lib/hello_sign/api/team.rb +0 -112
  1072. data/lib/hello_sign/api/template.rb +0 -218
  1073. data/lib/hello_sign/api/unclaimed_draft.rb +0 -277
  1074. data/lib/hello_sign/api.rb +0 -32
  1075. data/lib/hello_sign/client.rb +0 -333
  1076. data/lib/hello_sign/configuration.rb +0 -82
  1077. data/lib/hello_sign/error.rb +0 -100
  1078. data/lib/hello_sign/resource/account.rb +0 -46
  1079. data/lib/hello_sign/resource/api_app.rb +0 -46
  1080. data/lib/hello_sign/resource/base_resource.rb +0 -77
  1081. data/lib/hello_sign/resource/embedded.rb +0 -46
  1082. data/lib/hello_sign/resource/resource_array.rb +0 -59
  1083. data/lib/hello_sign/resource/signature_request.rb +0 -46
  1084. data/lib/hello_sign/resource/team.rb +0 -46
  1085. data/lib/hello_sign/resource/template.rb +0 -46
  1086. data/lib/hello_sign/resource/template_draft.rb +0 -47
  1087. data/lib/hello_sign/resource/unclaimed_draft.rb +0 -49
  1088. data/lib/hello_sign/resource.rb +0 -34
  1089. data/lib/hello_sign/version.rb +0 -27
  1090. data/lib/hello_sign.rb +0 -55
  1091. data/spec/fixtures/account.json +0 -15
  1092. data/spec/fixtures/api_app.json +0 -16
  1093. data/spec/fixtures/api_apps.json +0 -43
  1094. data/spec/fixtures/embedded.json +0 -6
  1095. data/spec/fixtures/empty.pdf +0 -0
  1096. data/spec/fixtures/error.json +0 -6
  1097. data/spec/fixtures/headers.json +0 -18
  1098. data/spec/fixtures/nda.pdf +0 -0
  1099. data/spec/fixtures/signature_request.json +0 -45
  1100. data/spec/fixtures/signature_requests.json +0 -44
  1101. data/spec/fixtures/team.json +0 -15
  1102. data/spec/fixtures/template.json +0 -53
  1103. data/spec/fixtures/templates.json +0 -59
  1104. data/spec/fixtures/token.json +0 -14
  1105. data/spec/fixtures/unclaimed_draft.json +0 -6
  1106. data/spec/hello_sign/.error_spec.rb.swp +0 -0
  1107. data/spec/hello_sign/api/account_spec.rb +0 -42
  1108. data/spec/hello_sign/api/api_app_spec.rb +0 -104
  1109. data/spec/hello_sign/api/embedded_spec.rb +0 -23
  1110. data/spec/hello_sign/api/oauth_spec.rb +0 -27
  1111. data/spec/hello_sign/api/signature_request_spec.rb +0 -230
  1112. data/spec/hello_sign/api/team_spec.rb +0 -101
  1113. data/spec/hello_sign/api/template_spec.rb +0 -172
  1114. data/spec/hello_sign/api/unclaimed_draft_spec.rb +0 -145
  1115. data/spec/hello_sign/client_spec.rb +0 -191
  1116. data/spec/hello_sign/error_spec.rb +0 -10
  1117. data/spec/hello_sign/resource/base_resource_spec.rb +0 -53
  1118. data/spec/hello_sign_spec.rb +0 -59
  1119. data/spec/scenarios/uploads_spec.rb +0 -19
@@ -1,218 +0,0 @@
1
- #
2
- # The MIT License (MIT)
3
- #
4
- # Copyright (C) 2014 hellosign.com
5
- #
6
- # Permission is hereby granted, free of charge, to any person obtaining a copy
7
- # of this software and associated documentation files (the "Software"), to deal
8
- # in the Software without restriction, including without limitation the rights
9
- # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
- # copies of the Software, and to permit persons to whom the Software is
11
- # furnished to do so, subject to the following conditions:
12
- #
13
- # The above copyright notice and this permission notice shall be included in all
14
- # copies or substantial portions of the Software.
15
- #
16
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
- # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
- # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
- # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
- # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
- # SOFTWARE.
23
- #
24
-
25
- module HelloSign
26
- module Api
27
-
28
- #
29
- # Contains all the API calls for the Template resource.
30
- # Take a look at our API Documentation for Templates (https://app.hellosign.com/api/reference#Template)
31
- # for more information about this.
32
- #
33
- # @author [hellosign]
34
- #
35
- module Template
36
-
37
- #
38
- # Retrieves the Template specified by the id parameter.
39
- # @option opts [String] template_id The Template ID to retrieve.
40
- #
41
- # @return [HelloSign::Resource::Template] a Template object
42
- #
43
- # @example
44
- # template = @client.get_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35'
45
- #
46
- def get_template(opts)
47
- HelloSign::Resource::Template.new get("/template/#{opts[:template_id]}")
48
- end
49
-
50
- #
51
- # Deletes the specified Template.
52
- # @option opts [String] template_id The Template ID to delete.
53
- #
54
- # @example
55
- # template = @client.delete_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35'
56
- #
57
- def delete_template(opts)
58
- post("/template/delete/#{opts[:template_id]}")
59
- end
60
-
61
- #
62
- # Retrieves the Templates for the accessible by the current user.
63
- #
64
- # @option opts [String] acount_id The Account ID to return Templates for and must be a team member. Use "all" for all team members. Defaults to current account. (optional)
65
- # @option opts [Integer] page Sets the page number of the list to return. Defaults to 1. (optional)
66
- # @option opts [Integer] page_size Determines the number of Templates returned per page. Defaults to 20. (optional)
67
- # @option opts [String] query Search terms and/or fields to filter the Templates. (optional)
68
- #
69
- # @return [HelloSign::Resource::ResourceArray] a ResourceArray object
70
- # @example
71
- # templates = @client.get_templates :page => 1
72
- #
73
- def get_templates(opts={})
74
- path = '/template/list'
75
- opts[:query] = create_search_string(opts[:query]) if opts[:query]
76
- query = create_query_string(opts, [:page, :page_size, :query])
77
- path += query
78
- HelloSign::Resource::ResourceArray.new get(path, opts), 'templates', HelloSign::Resource::Template
79
- end
80
-
81
- #
82
- # Gives the specified Account access to a Template. The Account must be part of your Team.
83
- #
84
- # @option opts [String] template_id The Template ID to give access to.
85
- # @option opts [String] account_id The Account ID to receive access to the Template.
86
- # @option opts [String] email_address The email address of the Account to receive access to the Template.
87
- # Note: The account_id prevails if both email_address and acccount_id are provided.
88
- #
89
- # @return [Template] a Template object
90
- # @example
91
- # templates = @client.add_user_to_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35', :email_address => 'george@example.com'
92
- #
93
- def add_user_to_template(opts)
94
- path = "/template/add_user/#{opts[:template_id]}"
95
- opts.delete(:template_id)
96
- HelloSign::Resource::Template.new post(path, :body => opts)
97
- end
98
-
99
- #
100
- # Removes the specified Account access to the specified Template.
101
- #
102
- # @option opts [String] template_id The Template ID to remove access to.
103
- # @option opts [String] account_id The Account ID to remove access to the Template.
104
- # @option opts [String] email_address The email address of the Account to remove access to the Template.
105
- # Note: The account_id prevails if both email_address and acccount_id are provided.
106
- #
107
- # @return [Template] a Template object
108
- # @example
109
- # templates = @client.remove_user_from_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35', :email_address => 'george@example.com'
110
- #
111
- def remove_user_from_template(opts)
112
- path = "/template/remove_user/#{opts[:template_id]}"
113
- opts.delete(:template_id)
114
- HelloSign::Resource::Template.new post(path, :body => opts)
115
- end
116
-
117
- #
118
- # Creates a new embedded template draft object that can be launched in an iFrame using the claim_url.
119
- # @option opts [Boolean] test_mode Indicates if this is a test Template draft. SignatureRequests using this Template will not be legally binding if set to 1. Defaults to 0. (optional)
120
- # @option opts [String] client_id The API App Client ID associated with the Template draft. (optional)
121
- # @option opts [Array<String>] files Specified file path(s) to upload file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
122
- # @option opts [Array<String>] file_urls URL(s) for HelloSign to download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
123
- # @option opts [String] title The default Template title. (optional)
124
- # @option opts [String] subject The default Template title alias. (optional)
125
- # @option opts [String] message The default message in the email that will be sent to the signer(s). (optional)
126
- # @option opts [Array<Hash>] signers List of signers displayed when the Template is used to create a SignatureRequest
127
- # * :name (String) Signer role name
128
- # * :order (Integer) The order the signer role is required to sign in. (optional)
129
- # @option opts [Array<Hash>] cc_roles The CC roles that must be assigned when using the Template to create a SignatureRequest. (optional)
130
- # @option opts [String<Array><Hash>] merge_fields List of fields that can be pre-populated by your application when using the Template to send a SignatureRequest. (optional)
131
- # * :name (String) Merge field name
132
- # * :type (String) Field type - either "text" or "checkbox"
133
- # @option opts [Boolean] skip_me_now Sets the "Me (Now)" option for the Template preparer. Defaults to 0. (optional)
134
- # @option opts [Boolean] use_preexisting_fields Sets the detection of predefined PDF fields. Defaults to 0. (optional)
135
- # @option opts [Hash] metadata Key-value data attached to the Template and all SignatureRequests created from the Template. (optional)
136
- # @option opts [Boolean] allow_reassign Sets the ability for signers to reassign the SignatureRequest to other signers. Defaults to 0. (optional)
137
- #
138
- # @example create_embedded_draft
139
- # template_draft = @client.create_embedded_template_draft(
140
- # :test_mode => 1,
141
- # :subject => 'The NDA we talked about',
142
- # :requester_email_address => requester@example.com",
143
- # :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
144
- # :signer_roles => [{
145
- # :name => 'Manager',
146
- # :order => 0
147
- # },{
148
- # :name => 'Client',
149
- # :order => 1
150
- # }
151
- # ],
152
- # :cc_roles => ['HRManager'],
153
- # :files => ['NDA.pdf', 'AppendixA.pdf'],
154
- # :merge_fields => '[{
155
- # :name => 'contract_id',
156
- # :type => 'text'
157
- # },{
158
- # :name => 'purchase_price',
159
- # :order => 'text'
160
- # }
161
- # ]'
162
- # )
163
- #
164
- def create_embedded_template_draft(opts)
165
- opts[:client_id] ||= self.client_id
166
- prepare_files opts
167
- prepare_signer_roles opts
168
- HelloSign::Resource::TemplateDraft.new post("/template/create_embedded_draft", :body => opts)
169
- end
170
-
171
- #
172
- # Downloads the original files of a specified Template.
173
- #
174
- # @option opts [String] template_id The Template ID to retrieve.
175
- # @option opts [String] file_type Determines the format of the file - either 'pdf' or 'zip' depending on the file type desired. Defaults to pdf. (optional)
176
- # @option opts [Boolean] get_url Response contains a URL link to the file if set to true. Links are only available for PDFs and have a TTL of 3 days. Defaults to false. (optional)
177
- #
178
- # @return a PDF or Zip
179
- # @example
180
- # templates = @client.get_template_files :template_id => 'f57db65d3f933b5316d398057a36176831451a35', :file_type => 'zip'
181
- #
182
- def get_template_files(opts)
183
- path = "/template/files/#{opts[:template_id]}"
184
- if opts[:file_type]
185
- path = path + "?file_type=#{opts[:file_type]}"
186
- end
187
- if opts[:get_url]
188
- separator = opts[:file_type].nil? ? '?' : '&'
189
- path = path + "#{separator}get_url=#{opts[:get_url]}"
190
- end
191
-
192
- get(path)
193
- end
194
-
195
- #
196
- # Overlays a new file with the overlay of the specified Template.
197
- #
198
- # @option opts [String] template_id The Template ID to update.
199
- # @option opts [Array<String>] files Specified file path(s) to upload file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
200
- # @option opts [Array<String>] file_urls URL(s) for HelloSign to download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
201
- # @option opts [String] subject The updated default Template title alias. (optional)
202
- # @option opts [String] message The updated default message in the email that will be sent to the signer(s). (optional)
203
- # @option opts [String] client_id The API App Client ID associated with the Template draft. (optional)
204
- # @option opts [Boolean] test_mode Indicates if this is a test Template draft. SignatureRequests using this Template will not be legally binding if set to 1. Defaults to 0. (optional)
205
- #
206
- # @return a Template ID
207
- # @example
208
- # templates = @client.update_template_files :template_id => 'f57db65d3f933b5316d398057a36176831451a35', :file => '@NDA.pdf'
209
- #
210
- def update_template_files(opts)
211
- template_id = opts.delete(:template_id)
212
- path = "/template/update_files/#{template_id}"
213
- prepare_files opts
214
- HelloSign::Resource::Template.new post(path, :body => opts)
215
- end
216
- end
217
- end
218
- end
@@ -1,277 +0,0 @@
1
- #
2
- # The MIT License (MIT)
3
- #
4
- # Copyright (C) 2014 hellosign.com
5
- #
6
- # Permission is hereby granted, free of charge, to any person obtaining a copy
7
- # of this software and associated documentation files (the "Software"), to deal
8
- # in the Software without restriction, including without limitation the rights
9
- # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
- # copies of the Software, and to permit persons to whom the Software is
11
- # furnished to do so, subject to the following conditions:
12
- #
13
- # The above copyright notice and this permission notice shall be included in all
14
- # copies or substantial portions of the Software.
15
- #
16
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
- # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
- # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
- # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
- # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
- # SOFTWARE.
23
- #
24
-
25
- module HelloSign
26
- module Api
27
-
28
- #
29
- # Contains all the API calls for the UnclaimedDraft resource.
30
- # Take a look at our API documentation for creating UnclaimedDrafts (https://app.hellosign.com/api/reference#UnclaimedDraft)
31
- # for more information about this.
32
- #
33
- # @author [hellosign]
34
- #
35
- module UnclaimedDraft
36
-
37
- #
38
- # Creates a new UnclaimedDraft that can be claimed using the claim_url.
39
- # The first authenticated user to access the claim_url claims the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded.
40
- # Subsequent access to the claim_url will result in a 404 not found error.
41
- # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
42
- # @option opts [Array<String>] files Specified file path(s) to upload file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
43
- # @option opts [Array<String>] file_urls URL(s) for HelloSign to download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
44
- # @option opts [String] type The type of UnclaimedDraft to create. Use "send_document" to create a claimable file, and "request_signature" for a claimable signature request.
45
- # * For "send_document," only the file parameter is required.
46
- # * For "request_signature," then signer name and email_address are required.
47
- # @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
48
- # @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
49
- # @option opts [Array<Hash>] signers List of signers, each item is a Hash with these keys: (optional)
50
- # * :name (String) Signer's name
51
- # * :email_address (String) Signer's email address
52
- # * :order (Integer) The order the signers are required to sign in (optional)
53
- # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present on the document with Text Tags or form_fields_per_document (optional)
54
- # * :name (String) Custom field name or "Field Label"
55
- # * :value (String) The value of the field. This data will appear on the SignatureRequest.
56
- # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed. (optional)
57
- # @option opts [String] signing_redirect_url The URL you want the signer(s) redirected to after they successfully sign. (optional)
58
- # @option opts [Boolean] use_text_tags Indicates whether the SignatureRequest should have Text Tags enabled. Defaults to 0. (optional)
59
- # @option opts [Boolean] hide_text_tags Indicates whether the Text Tags should be removed automatically. Note that this is not the preferred method. Defaults to 0. (optional)
60
- # @option opts [Boolean] use_preexisting_fields Sets the detection of predefined PDF fields. Defaults to 0. (optional)
61
- # @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
62
- # @option opts [Boolean] allow_decline Allows signers to decline the SignatureRequest. Defaults to 0. (optional)
63
- # @option opts [Boolean] allow_reassign Allows signers to reassign the SignatureRequest to another signer. Defaults to 0. (optional)
64
- # @option opts [Array<Hash>] form_fields_per_document The fields that should appear on the document. (optional)
65
- #
66
- # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft object
67
- #
68
- # @example type: send_document
69
- # unclaimed_draft = @client.create_unclaimed_draft(
70
- # :test_mode => 1,
71
- # :files => ['NDA.pdf', 'AppendixA.pdf']
72
- # )
73
- # @example type: request_signature
74
- # unclaimed_draft = @client.create_unclaimed_draft(
75
- # :test_mode => 1,
76
- # :type => 'request_signature',
77
- # :subject => 'The NDA we talked about',
78
- # :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
79
- # :metadata => {
80
- # :client_id => '1234',
81
- # :custom_text => 'NDA #9'
82
- # },
83
- # :signers => [{
84
- # :email_address => 'jack@example.com',
85
- # :name => 'Jack',
86
- # :order => 0
87
- # },{
88
- # :email_address => 'jill@example.com',
89
- # :name => 'Jill',
90
- # :order => 1
91
- # }
92
- # ],
93
- # :cc_email_addresses => ['lawyer@example.com', 'lawyer@example2.com'],
94
- # :files => ['NDA.pdf', 'AppendixA.pdf']
95
- # )
96
- #
97
- def create_unclaimed_draft opts
98
- prepare_files opts
99
- prepare_form_fields opts
100
- prepare_custom_fields opts
101
-
102
- if opts[:type] == 'request_signature'
103
- prepare_signers opts
104
- end
105
-
106
- HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create', :body => opts)
107
- end
108
-
109
- #
110
- # Creates a new Embedded UnclaimedDraft object that can be launched in an iFrame using the claim_url.
111
- # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
112
- # @option opts [String] client_id The API App Client ID associated with the UnclaimedDraft.
113
- # @option opts [Array<String>] files Specified file path(s) to upload file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
114
- # @option opts [Array<String>] file_urls URL(s) for HelloSign to download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
115
- # @option opts [String] requester_email_address The email address of the requester, if "request_signature" type.
116
- # @option opts [String] type The type of UnclaimedDraft to create. Use "send_document" to create a claimable file, and "request_signature" for a claimable signature request.
117
- # * For "send_document," only the file parameter is required.
118
- # * For "request_signature," then signer name and email_address are required.
119
- # @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
120
- # @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
121
- # @option opts [Array<Hash>] signers List of signers, each item is a Hash with these keys: (optional)
122
- # * :name (String) Signer's name
123
- # * :email_address (String) Signer's email address
124
- # * :order (Integer) The order the signers are required to sign in (optional)
125
- # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed. (optional)
126
- # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
127
- # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present on the document with Text Tags or form_fields_per_document (optional)
128
- # * :name (String) Custom field name or "Field Label"
129
- # * :value (String) The value of the field. This data will appear on the SignatureRequest.
130
- # @option opts [Boolean] use_text_tags Indicates whether the SignatureRequest should have Text Tags enabled. Defaults to 0. (optional)
131
- # @option opts [Boolean] hide_text_tags Indicates whether the Text Tags should be removed automatically. Note that this is not the preferred method. Defaults to 0. (optional)
132
- # @option opts [Boolean] use_preexisting_fields Sets the detection of predefined PDF fields. Defaults to 0. (optional)
133
- # @option opts [Boolean] is_for_embedded_signing Enable the UnclaimedDraft to be used for an Embedded SignatureRequest. Defaults to 0. (optional)
134
- # @option opts [Boolean] skip_me_now Disables the "Me (Now)" option for the preparer. Not available for type "send_document." Defaults to 0. (optional)
135
- # @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
136
- # @option opts [Boolean] allow_decline Allows signers to decline the SignatureRequest. Defaults to 0. (optional)
137
- # @option opts [Boolean] allow_reassign Allows signers to reassign the SignatureRequest to another signer. Defaults to 0. (optional)
138
- # @option opts [Array<Hash>] form_fields_per_document The fields that should appear on the document. (optional)
139
- #
140
- # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft object
141
- #
142
- # @example request_signature
143
- # unclaimed_draft = @client.create_embedded_unclaimed_draft(
144
- # :test_mode => 1,
145
- # :type => 'request_signature',
146
- # :subject => 'The NDA we talked about',
147
- # :requester_email_address => requester@example.com",
148
- # :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
149
- # :metadata => {
150
- # :client_id => '1234',
151
- # :custom_text => 'NDA #9'
152
- # },
153
- # :signers => [{
154
- # :email_address => 'jack@example.com',
155
- # :name => 'Jack',
156
- # :order => 0
157
- # },{
158
- # :email_address => 'jill@example.com',
159
- # :name => 'Jill',
160
- # :order => 1
161
- # }
162
- # ],
163
- # :cc_email_addresses => ['lawyer@example.com', 'lawyer@example2.com'],
164
- # :files => ['NDA.pdf', 'AppendixA.pdf']
165
- # )
166
- #
167
- def create_embedded_unclaimed_draft(opts)
168
- opts[:client_id] ||= self.client_id
169
- prepare_files opts
170
- prepare_form_fields opts
171
- prepare_custom_fields opts
172
-
173
- if opts[:type] == 'request_signature' || opts[:type] == 'send_document'
174
- prepare_signers opts
175
- end
176
-
177
- HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create_embedded', :body => opts)
178
- end
179
-
180
- #
181
- # Creates a new Embedded UnclaimedDraft object from a Template that can be launched in an iFrame using the claim_url.
182
- # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
183
- # @option opts [String] client_id The API App Client ID associated with the UnclaimedDraft.
184
- # @option opts [String] template_id The Template ID to use when creating the UnclaimedDraft.
185
- # * Use template_ids[%i%] if using multiple templates, replacing %i% with an integer to indicate the order of the Templates
186
- # @option opts [String] requester_email_address The email address of the requester, if "request_signature" type.
187
- # @option opts [String] title The title you want to assign to the SignatureRequest. (optional)
188
- # @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
189
- # @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
190
- # @option opts [Array<Hash>] signers List of signers
191
- # * :role (String) The signer role indicated on the Template. Note that the role name is case sensitive.
192
- # * :name (String) Signer's name
193
- # * :email_address (String) Signer's email address
194
- # @option opts [Array<Hash>] ccs The individual(s) to be CC'd on the SignatureRequest. Required when a CC role exists for the Template.
195
- # * :role (String) The CC role indicated on the Template. Note that the role name is case sensitive.
196
- # * :email_address (String) CC Recipient's email address
197
- # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
198
- # @option opts [String] requesting_redirect_url The URL you want the requester redirected to after they successfully request a SignatureRequest. (optional)
199
- # @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
200
- # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present in the Template. (optional)
201
- # * :name (String) Custom field name or "Field Label"
202
- # * :value (String) The value of the field. This data will appear on the SignatureRequest.
203
- # @option opts [Array<String>] files Use files to indicate the uploaded file(s) to append to the SignatureRequest. (optional)
204
- # @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to append to the SignatureRequest. (optional)
205
- # @option opts [Boolean] skip_me_now Disables the "Me (Now)" option for the preparer. Not available for type "send_document." Defaults to 0. (optional)
206
- # @option opts [Boolean] allow_decline Allows signers to decline the SignatureRequest. Defaults to 0. (optional)
207
- # @option opts [Boolean] allow_reassign Allows signers to reassign the SignatureRequest to another signer. Defaults to 0. (optional)
208
- #
209
- # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft object
210
- #
211
- # @example request_signature
212
- # unclaimed_draft = @client.create_embedded_unclaimed_draft_with_template(
213
- # :test_mode => 1,
214
- # :subject => 'The NDA we talked about',
215
- # :template_id => 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
216
- # :requester_email_address => requester@example.com",
217
- # :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
218
- # :files => ['NDA.pdf', 'AppendixA.pdf'],
219
- # :metadata => {
220
- # :client_id => '1234',
221
- # :custom_text => 'NDA #9'
222
- # },
223
- # :signers => [
224
- # {
225
- # :email_address => 'george@example.com',
226
- # :name => 'George',
227
- # :role => 'Client'
228
- # }
229
- # ],
230
- # :ccs => [
231
- # {
232
- # :email_address =>'accounting@example.com',
233
- # :role => "Accounting"
234
- # }
235
- # ],
236
- # :custom_fields => {
237
- # :Cost => '$20,000'
238
- # }
239
- # )
240
- #
241
- def create_embedded_unclaimed_draft_with_template(opts)
242
- opts[:client_id] ||= self.client_id
243
- prepare_signers opts
244
- prepare_custom_fields opts
245
- prepare_ccs opts
246
- prepare_templates opts
247
- prepare_files opts
248
- HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create_embedded_with_template', :body => opts)
249
- end
250
-
251
- #
252
- # Creates a new SignatureRequest from an Embedded UnclaimedDraft. This UnclaimedDraft can be
253
- # edited using the claim_url.
254
- # @option opts [String] signature_request_id The SignatureRequest ID to edit and resend.
255
- # @option opts [String] client_id The API App Client ID associated with the UnclaimedDraft.
256
- # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
257
- # @option opts [String] requesting_redirect_url The URL you want the requester redirected to after they successfully request a SignatureRequest. (optional)
258
- # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
259
- # @option opts [Boolean] is_for_embedded_signing Enable the UnclaimedDraft to be used for an Embedded SignatureRequest. Defaults to 0. (optional)
260
- #
261
- # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft object
262
- #
263
- # @example
264
- # unclaimed_draft = @client.edit_and_resend_unclaimed_draft(
265
- # :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491',
266
- # :test_mode => 1,
267
- # :client_id => 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
268
- # )
269
- #
270
- def edit_and_resend_unclaimed_draft(opts)
271
- signature_request_id = opts.delete(:signature_request_id)
272
- path = "/unclaimed_draft/edit_and_resend/#{signature_request_id}"
273
- HelloSign::Resource::UnclaimedDraft.new post(path, :body => opts)
274
- end
275
- end
276
- end
277
- end
@@ -1,32 +0,0 @@
1
- #
2
- # The MIT License (MIT)
3
- #
4
- # Copyright (C) 2014 hellosign.com
5
- #
6
- # Permission is hereby granted, free of charge, to any person obtaining a copy
7
- # of this software and associated documentation files (the "Software"), to deal
8
- # in the Software without restriction, including without limitation the rights
9
- # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
- # copies of the Software, and to permit persons to whom the Software is
11
- # furnished to do so, subject to the following conditions:
12
- #
13
- # The above copyright notice and this permission notice shall be included in all
14
- # copies or substantial portions of the Software.
15
- #
16
- # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
- # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
- # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
- # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
- # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
- # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
- # SOFTWARE.
23
- #
24
-
25
- require 'hello_sign/api/account'
26
- require 'hello_sign/api/embedded'
27
- require 'hello_sign/api/template'
28
- require 'hello_sign/api/signature_request'
29
- require 'hello_sign/api/team'
30
- require 'hello_sign/api/unclaimed_draft'
31
- require 'hello_sign/api/oauth'
32
- require 'hello_sign/api/api_app'