dropbox-sign 1.0.0.pre.beta2301

Sign up to get free protection for your applications and to get access to all the features.
Files changed (552) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +10 -0
  3. data/Gemfile.lock +78 -0
  4. data/LICENSE +21 -0
  5. data/README.md +333 -0
  6. data/Rakefile +10 -0
  7. data/bin/generate-examples.php +269 -0
  8. data/bin/php +16 -0
  9. data/bin/replace +11 -0
  10. data/bin/ruby +16 -0
  11. data/bin/scan_for +32 -0
  12. data/composer.json +10 -0
  13. data/composer.lock +246 -0
  14. data/docs/AccountApi.md +301 -0
  15. data/docs/AccountCreateRequest.md +13 -0
  16. data/docs/AccountCreateResponse.md +12 -0
  17. data/docs/AccountGetResponse.md +11 -0
  18. data/docs/AccountResponse.md +19 -0
  19. data/docs/AccountResponseQuotas.md +14 -0
  20. data/docs/AccountUpdateRequest.md +12 -0
  21. data/docs/AccountVerifyRequest.md +10 -0
  22. data/docs/AccountVerifyResponse.md +11 -0
  23. data/docs/AccountVerifyResponseAccount.md +10 -0
  24. data/docs/ApiAppApi.md +402 -0
  25. data/docs/ApiAppCreateRequest.md +16 -0
  26. data/docs/ApiAppGetResponse.md +11 -0
  27. data/docs/ApiAppListResponse.md +12 -0
  28. data/docs/ApiAppResponse.md +19 -0
  29. data/docs/ApiAppResponseOAuth.md +13 -0
  30. data/docs/ApiAppResponseOptions.md +10 -0
  31. data/docs/ApiAppResponseOwnerAccount.md +11 -0
  32. data/docs/ApiAppResponseWhiteLabelingOptions.md +23 -0
  33. data/docs/ApiAppUpdateRequest.md +16 -0
  34. data/docs/BulkSendJobApi.md +155 -0
  35. data/docs/BulkSendJobGetResponse.md +13 -0
  36. data/docs/BulkSendJobGetResponseSignatureRequests.md +33 -0
  37. data/docs/BulkSendJobListResponse.md +12 -0
  38. data/docs/BulkSendJobResponse.md +13 -0
  39. data/docs/BulkSendJobSendResponse.md +11 -0
  40. data/docs/EmbeddedApi.md +158 -0
  41. data/docs/EmbeddedEditUrlRequest.md +19 -0
  42. data/docs/EmbeddedEditUrlResponse.md +11 -0
  43. data/docs/EmbeddedEditUrlResponseEmbedded.md +11 -0
  44. data/docs/EmbeddedSignUrlResponse.md +11 -0
  45. data/docs/EmbeddedSignUrlResponseEmbedded.md +11 -0
  46. data/docs/ErrorResponse.md +10 -0
  47. data/docs/ErrorResponseError.md +12 -0
  48. data/docs/EventCallbackRequest.md +13 -0
  49. data/docs/EventCallbackRequestEvent.md +13 -0
  50. data/docs/EventCallbackRequestEventMetadata.md +13 -0
  51. data/docs/FileResponse.md +11 -0
  52. data/docs/FileResponseDataUri.md +10 -0
  53. data/docs/ListInfoResponse.md +13 -0
  54. data/docs/OAuthApi.md +158 -0
  55. data/docs/OAuthTokenGenerateRequest.md +14 -0
  56. data/docs/OAuthTokenRefreshRequest.md +11 -0
  57. data/docs/OAuthTokenResponse.md +14 -0
  58. data/docs/ReportApi.md +83 -0
  59. data/docs/ReportCreateRequest.md +12 -0
  60. data/docs/ReportCreateResponse.md +11 -0
  61. data/docs/ReportResponse.md +13 -0
  62. data/docs/SignatureRequestApi.md +1377 -0
  63. data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +22 -0
  64. data/docs/SignatureRequestBulkSendWithTemplateRequest.md +22 -0
  65. data/docs/SignatureRequestCreateEmbeddedRequest.md +33 -0
  66. data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +24 -0
  67. data/docs/SignatureRequestGetResponse.md +11 -0
  68. data/docs/SignatureRequestListResponse.md +12 -0
  69. data/docs/SignatureRequestRemindRequest.md +11 -0
  70. data/docs/SignatureRequestResponse.md +32 -0
  71. data/docs/SignatureRequestResponseAttachment.md +15 -0
  72. data/docs/SignatureRequestResponseCustomFieldBase.md +17 -0
  73. data/docs/SignatureRequestResponseCustomFieldCheckbox.md +11 -0
  74. data/docs/SignatureRequestResponseCustomFieldText.md +11 -0
  75. data/docs/SignatureRequestResponseCustomFieldTypeEnum.md +9 -0
  76. data/docs/SignatureRequestResponseDataBase.md +14 -0
  77. data/docs/SignatureRequestResponseDataTypeEnum.md +9 -0
  78. data/docs/SignatureRequestResponseDataValueCheckbox.md +11 -0
  79. data/docs/SignatureRequestResponseDataValueCheckboxMerge.md +11 -0
  80. data/docs/SignatureRequestResponseDataValueDateSigned.md +11 -0
  81. data/docs/SignatureRequestResponseDataValueDropdown.md +11 -0
  82. data/docs/SignatureRequestResponseDataValueInitials.md +11 -0
  83. data/docs/SignatureRequestResponseDataValueRadio.md +11 -0
  84. data/docs/SignatureRequestResponseDataValueSignature.md +11 -0
  85. data/docs/SignatureRequestResponseDataValueText.md +11 -0
  86. data/docs/SignatureRequestResponseDataValueTextMerge.md +11 -0
  87. data/docs/SignatureRequestResponseSignatures.md +28 -0
  88. data/docs/SignatureRequestSendRequest.md +34 -0
  89. data/docs/SignatureRequestSendWithTemplateRequest.md +25 -0
  90. data/docs/SignatureRequestUpdateRequest.md +13 -0
  91. data/docs/SubAttachment.md +13 -0
  92. data/docs/SubBulkSignerList.md +11 -0
  93. data/docs/SubBulkSignerListCustomField.md +11 -0
  94. data/docs/SubCC.md +11 -0
  95. data/docs/SubCustomField.md +17 -0
  96. data/docs/SubEditorOptions.md +11 -0
  97. data/docs/SubFieldOptions.md +10 -0
  98. data/docs/SubFormFieldGroup.md +12 -0
  99. data/docs/SubFormFieldRule.md +13 -0
  100. data/docs/SubFormFieldRuleAction.md +13 -0
  101. data/docs/SubFormFieldRuleTrigger.md +13 -0
  102. data/docs/SubFormFieldsPerDocumentBase.md +33 -0
  103. data/docs/SubFormFieldsPerDocumentCheckbox.md +12 -0
  104. data/docs/SubFormFieldsPerDocumentCheckboxMerge.md +10 -0
  105. data/docs/SubFormFieldsPerDocumentDateSigned.md +10 -0
  106. data/docs/SubFormFieldsPerDocumentDropdown.md +12 -0
  107. data/docs/SubFormFieldsPerDocumentHyperlink.md +12 -0
  108. data/docs/SubFormFieldsPerDocumentInitials.md +10 -0
  109. data/docs/SubFormFieldsPerDocumentRadio.md +12 -0
  110. data/docs/SubFormFieldsPerDocumentSignature.md +10 -0
  111. data/docs/SubFormFieldsPerDocumentText.md +17 -0
  112. data/docs/SubFormFieldsPerDocumentTextMerge.md +10 -0
  113. data/docs/SubFormFieldsPerDocumentTypeEnum.md +9 -0
  114. data/docs/SubMergeField.md +11 -0
  115. data/docs/SubOAuth.md +11 -0
  116. data/docs/SubOptions.md +10 -0
  117. data/docs/SubSignatureRequestGroupedSigners.md +12 -0
  118. data/docs/SubSignatureRequestSigner.md +15 -0
  119. data/docs/SubSignatureRequestTemplateSigner.md +15 -0
  120. data/docs/SubSigningOptions.md +16 -0
  121. data/docs/SubTeamResponse.md +11 -0
  122. data/docs/SubTemplateRole.md +11 -0
  123. data/docs/SubUnclaimedDraftSigner.md +12 -0
  124. data/docs/SubUnclaimedDraftTemplateSigner.md +12 -0
  125. data/docs/SubWhiteLabelingOptions.md +26 -0
  126. data/docs/TeamAddMemberRequest.md +12 -0
  127. data/docs/TeamApi.md +737 -0
  128. data/docs/TeamCreateRequest.md +10 -0
  129. data/docs/TeamGetInfoResponse.md +11 -0
  130. data/docs/TeamGetResponse.md +11 -0
  131. data/docs/TeamInfoResponse.md +14 -0
  132. data/docs/TeamInviteResponse.md +15 -0
  133. data/docs/TeamInvitesResponse.md +11 -0
  134. data/docs/TeamMemberResponse.md +12 -0
  135. data/docs/TeamMembersResponse.md +12 -0
  136. data/docs/TeamParentResponse.md +11 -0
  137. data/docs/TeamRemoveMemberRequest.md +14 -0
  138. data/docs/TeamResponse.md +12 -0
  139. data/docs/TeamSubTeamsResponse.md +12 -0
  140. data/docs/TeamUpdateRequest.md +10 -0
  141. data/docs/TemplateAddUserRequest.md +12 -0
  142. data/docs/TemplateApi.md +782 -0
  143. data/docs/TemplateCreateEmbeddedDraftRequest.md +34 -0
  144. data/docs/TemplateCreateEmbeddedDraftResponse.md +11 -0
  145. data/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +13 -0
  146. data/docs/TemplateEditResponse.md +10 -0
  147. data/docs/TemplateGetResponse.md +11 -0
  148. data/docs/TemplateListResponse.md +12 -0
  149. data/docs/TemplateRemoveUserRequest.md +11 -0
  150. data/docs/TemplateResponse.md +24 -0
  151. data/docs/TemplateResponseAccount.md +15 -0
  152. data/docs/TemplateResponseAccountQuota.md +13 -0
  153. data/docs/TemplateResponseCCRole.md +10 -0
  154. data/docs/TemplateResponseCustomField.md +22 -0
  155. data/docs/TemplateResponseDocument.md +15 -0
  156. data/docs/TemplateResponseDocumentCustomField.md +25 -0
  157. data/docs/TemplateResponseDocumentFieldGroup.md +11 -0
  158. data/docs/TemplateResponseDocumentFormField.md +23 -0
  159. data/docs/TemplateResponseDocumentStaticField.md +19 -0
  160. data/docs/TemplateResponseFieldAvgTextLength.md +11 -0
  161. data/docs/TemplateResponseNamedFormField.md +23 -0
  162. data/docs/TemplateResponseSignerRole.md +11 -0
  163. data/docs/TemplateUpdateFilesRequest.md +15 -0
  164. data/docs/TemplateUpdateFilesResponse.md +10 -0
  165. data/docs/TemplateUpdateFilesResponseTemplate.md +11 -0
  166. data/docs/UnclaimedDraftApi.md +359 -0
  167. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +45 -0
  168. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +38 -0
  169. data/docs/UnclaimedDraftCreateRequest.md +33 -0
  170. data/docs/UnclaimedDraftCreateResponse.md +11 -0
  171. data/docs/UnclaimedDraftEditAndResendRequest.md +17 -0
  172. data/docs/UnclaimedDraftResponse.md +15 -0
  173. data/docs/WarningResponse.md +11 -0
  174. data/dropbox-sign.gemspec +38 -0
  175. data/examples/AccountCreate.rb +21 -0
  176. data/examples/AccountGet.rb +18 -0
  177. data/examples/AccountUpdate.rb +21 -0
  178. data/examples/AccountVerify.rb +21 -0
  179. data/examples/ApiAppCreate.rb +35 -0
  180. data/examples/ApiAppDelete.rb +20 -0
  181. data/examples/ApiAppGet.rb +20 -0
  182. data/examples/ApiAppList.rb +21 -0
  183. data/examples/ApiAppUpdate.rb +32 -0
  184. data/examples/BulkSendJobGet.rb +20 -0
  185. data/examples/BulkSendJobList.rb +21 -0
  186. data/examples/EmbeddedEditUrl.rb +24 -0
  187. data/examples/EmbeddedSignUrl.rb +20 -0
  188. data/examples/EventCallback.rb +32 -0
  189. data/examples/OauthTokenGenerate.rb +24 -0
  190. data/examples/OauthTokenRefresh.rb +21 -0
  191. data/examples/ReportCreate.rb +23 -0
  192. data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
  193. data/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
  194. data/examples/SignatureRequestCancel.rb +20 -0
  195. data/examples/SignatureRequestCreateEmbedded.rb +46 -0
  196. data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
  197. data/examples/SignatureRequestFiles.rb +20 -0
  198. data/examples/SignatureRequestFilesAsDataUri.rb +20 -0
  199. data/examples/SignatureRequestFilesAsFileUrl.rb +20 -0
  200. data/examples/SignatureRequestGet.rb +20 -0
  201. data/examples/SignatureRequestList.rb +21 -0
  202. data/examples/SignatureRequestReleaseHold.rb +20 -0
  203. data/examples/SignatureRequestRemind.rb +23 -0
  204. data/examples/SignatureRequestRemove.rb +20 -0
  205. data/examples/SignatureRequestSend.rb +56 -0
  206. data/examples/SignatureRequestSendWithTemplate.rb +50 -0
  207. data/examples/SignatureRequestUpdate.rb +24 -0
  208. data/examples/TeamAddMember.rb +21 -0
  209. data/examples/TeamCreate.rb +21 -0
  210. data/examples/TeamDelete.rb +18 -0
  211. data/examples/TeamGet.rb +18 -0
  212. data/examples/TeamInfo.rb +18 -0
  213. data/examples/TeamInvites.rb +20 -0
  214. data/examples/TeamMembers.rb +20 -0
  215. data/examples/TeamRemoveMember.rb +22 -0
  216. data/examples/TeamSubTeams.rb +20 -0
  217. data/examples/TeamUpdate.rb +21 -0
  218. data/examples/TemplateAddUser.rb +23 -0
  219. data/examples/TemplateCreateEmbeddedDraft.rb +49 -0
  220. data/examples/TemplateDelete.rb +20 -0
  221. data/examples/TemplateFiles.rb +20 -0
  222. data/examples/TemplateFilesAsDataUri.rb +20 -0
  223. data/examples/TemplateFilesAsFileUrl.rb +20 -0
  224. data/examples/TemplateGet.rb +20 -0
  225. data/examples/TemplateList.rb +20 -0
  226. data/examples/TemplateRemoveUser.rb +23 -0
  227. data/examples/TemplateUpdateFiles.rb +23 -0
  228. data/examples/UnclaimedDraftCreate.rb +56 -0
  229. data/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
  230. data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
  231. data/examples/UnclaimedDraftEditAndResend.rb +24 -0
  232. data/lib/dropbox-sign/api/account_api.rb +446 -0
  233. data/lib/dropbox-sign/api/api_app_api.rb +504 -0
  234. data/lib/dropbox-sign/api/bulk_send_job_api.rb +213 -0
  235. data/lib/dropbox-sign/api/embedded_api.rb +234 -0
  236. data/lib/dropbox-sign/api/o_auth_api.rb +215 -0
  237. data/lib/dropbox-sign/api/report_api.rb +134 -0
  238. data/lib/dropbox-sign/api/signature_request_api.rb +1620 -0
  239. data/lib/dropbox-sign/api/team_api.rb +1011 -0
  240. data/lib/dropbox-sign/api/template_api.rb +1037 -0
  241. data/lib/dropbox-sign/api/unclaimed_draft_api.rb +467 -0
  242. data/lib/dropbox-sign/api_client.rb +417 -0
  243. data/lib/dropbox-sign/api_error.rb +60 -0
  244. data/lib/dropbox-sign/configuration.rb +303 -0
  245. data/lib/dropbox-sign/event_callback_helper.rb +54 -0
  246. data/lib/dropbox-sign/models/account_create_request.rb +285 -0
  247. data/lib/dropbox-sign/models/account_create_response.rb +270 -0
  248. data/lib/dropbox-sign/models/account_get_response.rb +261 -0
  249. data/lib/dropbox-sign/models/account_response.rb +343 -0
  250. data/lib/dropbox-sign/models/account_response_quotas.rb +296 -0
  251. data/lib/dropbox-sign/models/account_update_request.rb +271 -0
  252. data/lib/dropbox-sign/models/account_verify_request.rb +255 -0
  253. data/lib/dropbox-sign/models/account_verify_response.rb +261 -0
  254. data/lib/dropbox-sign/models/account_verify_response_account.rb +250 -0
  255. data/lib/dropbox-sign/models/api_app_create_request.rb +347 -0
  256. data/lib/dropbox-sign/models/api_app_get_response.rb +261 -0
  257. data/lib/dropbox-sign/models/api_app_list_response.rb +273 -0
  258. data/lib/dropbox-sign/models/api_app_response.rb +343 -0
  259. data/lib/dropbox-sign/models/api_app_response_o_auth.rb +283 -0
  260. data/lib/dropbox-sign/models/api_app_response_options.rb +251 -0
  261. data/lib/dropbox-sign/models/api_app_response_owner_account.rb +261 -0
  262. data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +367 -0
  263. data/lib/dropbox-sign/models/api_app_update_request.rb +324 -0
  264. data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +282 -0
  265. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +503 -0
  266. data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +273 -0
  267. data/lib/dropbox-sign/models/bulk_send_job_response.rb +282 -0
  268. data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +261 -0
  269. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +357 -0
  270. data/lib/dropbox-sign/models/embedded_edit_url_response.rb +261 -0
  271. data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +261 -0
  272. data/lib/dropbox-sign/models/embedded_sign_url_response.rb +261 -0
  273. data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +261 -0
  274. data/lib/dropbox-sign/models/error_response.rb +254 -0
  275. data/lib/dropbox-sign/models/error_response_error.rb +281 -0
  276. data/lib/dropbox-sign/models/event_callback_request.rb +281 -0
  277. data/lib/dropbox-sign/models/event_callback_request_event.rb +334 -0
  278. data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +285 -0
  279. data/lib/dropbox-sign/models/file_response.rb +260 -0
  280. data/lib/dropbox-sign/models/file_response_data_uri.rb +250 -0
  281. data/lib/dropbox-sign/models/list_info_response.rb +282 -0
  282. data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +317 -0
  283. data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +272 -0
  284. data/lib/dropbox-sign/models/o_auth_token_response.rb +287 -0
  285. data/lib/dropbox-sign/models/report_create_request.rb +319 -0
  286. data/lib/dropbox-sign/models/report_create_response.rb +261 -0
  287. data/lib/dropbox-sign/models/report_response.rb +305 -0
  288. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +445 -0
  289. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +440 -0
  290. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +569 -0
  291. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +475 -0
  292. data/lib/dropbox-sign/models/signature_request_get_response.rb +261 -0
  293. data/lib/dropbox-sign/models/signature_request_list_response.rb +273 -0
  294. data/lib/dropbox-sign/models/signature_request_remind_request.rb +265 -0
  295. data/lib/dropbox-sign/models/signature_request_response.rb +494 -0
  296. data/lib/dropbox-sign/models/signature_request_response_attachment.rb +323 -0
  297. data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +316 -0
  298. data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +272 -0
  299. data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +272 -0
  300. data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +40 -0
  301. data/lib/dropbox-sign/models/signature_request_response_data_base.rb +326 -0
  302. data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +47 -0
  303. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +266 -0
  304. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +266 -0
  305. data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +266 -0
  306. data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +266 -0
  307. data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +266 -0
  308. data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +266 -0
  309. data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +266 -0
  310. data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +266 -0
  311. data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +266 -0
  312. data/lib/dropbox-sign/models/signature_request_response_signatures.rb +446 -0
  313. data/lib/dropbox-sign/models/signature_request_send_request.rb +574 -0
  314. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +480 -0
  315. data/lib/dropbox-sign/models/signature_request_update_request.rb +286 -0
  316. data/lib/dropbox-sign/models/sub_attachment.rb +292 -0
  317. data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +264 -0
  318. data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +270 -0
  319. data/lib/dropbox-sign/models/sub_cc.rb +270 -0
  320. data/lib/dropbox-sign/models/sub_custom_field.rb +288 -0
  321. data/lib/dropbox-sign/models/sub_editor_options.rb +265 -0
  322. data/lib/dropbox-sign/models/sub_field_options.rb +290 -0
  323. data/lib/dropbox-sign/models/sub_form_field_group.rb +285 -0
  324. data/lib/dropbox-sign/models/sub_form_field_rule.rb +353 -0
  325. data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +323 -0
  326. data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +326 -0
  327. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +435 -0
  328. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +287 -0
  329. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +262 -0
  330. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +262 -0
  331. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +308 -0
  332. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +292 -0
  333. data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +262 -0
  334. data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +292 -0
  335. data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +262 -0
  336. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +364 -0
  337. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +262 -0
  338. data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +48 -0
  339. data/lib/dropbox-sign/models/sub_merge_field.rb +304 -0
  340. data/lib/dropbox-sign/models/sub_o_auth.rb +285 -0
  341. data/lib/dropbox-sign/models/sub_options.rb +253 -0
  342. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +283 -0
  343. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +369 -0
  344. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +373 -0
  345. data/lib/dropbox-sign/models/sub_signing_options.rb +338 -0
  346. data/lib/dropbox-sign/models/sub_team_response.rb +260 -0
  347. data/lib/dropbox-sign/models/sub_template_role.rb +261 -0
  348. data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +281 -0
  349. data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +285 -0
  350. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +439 -0
  351. data/lib/dropbox-sign/models/team_add_member_request.rb +304 -0
  352. data/lib/dropbox-sign/models/team_create_request.rb +252 -0
  353. data/lib/dropbox-sign/models/team_get_info_response.rb +261 -0
  354. data/lib/dropbox-sign/models/team_get_response.rb +261 -0
  355. data/lib/dropbox-sign/models/team_info_response.rb +290 -0
  356. data/lib/dropbox-sign/models/team_invite_response.rb +300 -0
  357. data/lib/dropbox-sign/models/team_invites_response.rb +263 -0
  358. data/lib/dropbox-sign/models/team_member_response.rb +270 -0
  359. data/lib/dropbox-sign/models/team_members_response.rb +272 -0
  360. data/lib/dropbox-sign/models/team_parent_response.rb +261 -0
  361. data/lib/dropbox-sign/models/team_remove_member_request.rb +324 -0
  362. data/lib/dropbox-sign/models/team_response.rb +274 -0
  363. data/lib/dropbox-sign/models/team_sub_teams_response.rb +272 -0
  364. data/lib/dropbox-sign/models/team_update_request.rb +250 -0
  365. data/lib/dropbox-sign/models/template_add_user_request.rb +272 -0
  366. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +567 -0
  367. data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +261 -0
  368. data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +283 -0
  369. data/lib/dropbox-sign/models/template_edit_response.rb +250 -0
  370. data/lib/dropbox-sign/models/template_get_response.rb +261 -0
  371. data/lib/dropbox-sign/models/template_list_response.rb +273 -0
  372. data/lib/dropbox-sign/models/template_remove_user_request.rb +260 -0
  373. data/lib/dropbox-sign/models/template_response.rb +410 -0
  374. data/lib/dropbox-sign/models/template_response_account.rb +299 -0
  375. data/lib/dropbox-sign/models/template_response_account_quota.rb +281 -0
  376. data/lib/dropbox-sign/models/template_response_cc_role.rb +250 -0
  377. data/lib/dropbox-sign/models/template_response_custom_field.rb +407 -0
  378. data/lib/dropbox-sign/models/template_response_document.rb +309 -0
  379. data/lib/dropbox-sign/models/template_response_document_custom_field.rb +438 -0
  380. data/lib/dropbox-sign/models/template_response_document_field_group.rb +260 -0
  381. data/lib/dropbox-sign/models/template_response_document_form_field.rb +417 -0
  382. data/lib/dropbox-sign/models/template_response_document_static_field.rb +341 -0
  383. data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +261 -0
  384. data/lib/dropbox-sign/models/template_response_named_form_field.rb +383 -0
  385. data/lib/dropbox-sign/models/template_response_signer_role.rb +260 -0
  386. data/lib/dropbox-sign/models/template_update_files_request.rb +336 -0
  387. data/lib/dropbox-sign/models/template_update_files_response.rb +249 -0
  388. data/lib/dropbox-sign/models/template_update_files_response_template.rb +263 -0
  389. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +728 -0
  390. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +631 -0
  391. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +586 -0
  392. data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +261 -0
  393. data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +328 -0
  394. data/lib/dropbox-sign/models/unclaimed_draft_response.rb +305 -0
  395. data/lib/dropbox-sign/models/warning_response.rb +271 -0
  396. data/lib/dropbox-sign/version.rb +18 -0
  397. data/lib/dropbox-sign.rb +204 -0
  398. data/openapi-config.yaml +21 -0
  399. data/openapi-sdk.yaml +11080 -0
  400. data/run-build +53 -0
  401. data/spec/api/account_api_spec.rb +107 -0
  402. data/spec/api/api_app_api_spec.rb +95 -0
  403. data/spec/api/bulk_send_job_api_spec.rb +52 -0
  404. data/spec/api/embedded_api_spec.rb +55 -0
  405. data/spec/api/oauth_api_spec.rb +55 -0
  406. data/spec/api/report_api_spec.rb +38 -0
  407. data/spec/api/signature_request_api_spec.rb +263 -0
  408. data/spec/api/team_api_spec.rb +105 -0
  409. data/spec/api/template_api_spec.rb +147 -0
  410. data/spec/api/unclaimed_draft_api_spec.rb +95 -0
  411. data/spec/api_client_spec.rb +226 -0
  412. data/spec/configuration_spec.rb +42 -0
  413. data/spec/event_callback_helper_spec.rb +22 -0
  414. data/spec/fixtures_spec.rb +59 -0
  415. data/spec/models/sub_form_fields_per_document_base_spec.rb +24 -0
  416. data/spec/spec_helper.rb +111 -0
  417. data/spec/test_utils.rb +19 -0
  418. data/templates/Gemfile.mustache +10 -0
  419. data/templates/README.mustache +133 -0
  420. data/templates/Rakefile.mustache +10 -0
  421. data/templates/api.mustache +283 -0
  422. data/templates/api_client.mustache +291 -0
  423. data/templates/api_client_faraday_partial.mustache +136 -0
  424. data/templates/api_client_spec.mustache +220 -0
  425. data/templates/api_client_typhoeus_partial.mustache +153 -0
  426. data/templates/api_doc.mustache +77 -0
  427. data/templates/api_error.mustache +52 -0
  428. data/templates/api_info.mustache +12 -0
  429. data/templates/api_test.mustache +47 -0
  430. data/templates/base_object.mustache +132 -0
  431. data/templates/configuration.mustache +372 -0
  432. data/templates/configuration_spec.mustache +34 -0
  433. data/templates/configuration_tls_faraday_partial.mustache +29 -0
  434. data/templates/configuration_tls_typhoeus_partial.mustache +34 -0
  435. data/templates/event_callback_helper.mustache +46 -0
  436. data/templates/gem.mustache +55 -0
  437. data/templates/gemspec.mustache +35 -0
  438. data/templates/git_push.sh.mustache +57 -0
  439. data/templates/gitignore.mustache +41 -0
  440. data/templates/model.mustache +29 -0
  441. data/templates/model_doc.mustache +12 -0
  442. data/templates/model_test.mustache +77 -0
  443. data/templates/partial_model_enum_class.mustache +20 -0
  444. data/templates/partial_model_generic.mustache +414 -0
  445. data/templates/partial_model_generic_doc.mustache +10 -0
  446. data/templates/partial_oneof_module.mustache +137 -0
  447. data/templates/partial_oneof_module_doc.mustache +92 -0
  448. data/templates/rspec.mustache +2 -0
  449. data/templates/rubocop.mustache +148 -0
  450. data/templates/spec_helper.mustache +103 -0
  451. data/templates/travis.mustache +14 -0
  452. data/templates/version.mustache +10 -0
  453. data/test_fixtures/AccountCreateRequest.json +7 -0
  454. data/test_fixtures/AccountCreateResponse.json +15 -0
  455. data/test_fixtures/AccountGetResponse.json +14 -0
  456. data/test_fixtures/AccountUpdateRequest.json +5 -0
  457. data/test_fixtures/AccountVerifyRequest.json +5 -0
  458. data/test_fixtures/AccountVerifyResponse.json +7 -0
  459. data/test_fixtures/ApiAppCreateRequest.json +35 -0
  460. data/test_fixtures/ApiAppGetResponse.json +27 -0
  461. data/test_fixtures/ApiAppListResponse.json +42 -0
  462. data/test_fixtures/ApiAppUpdateRequest.json +35 -0
  463. data/test_fixtures/BulkSendJobGetResponse.json +67 -0
  464. data/test_fixtures/BulkSendJobListResponse.json +24 -0
  465. data/test_fixtures/BulkSendJobSendResponse.json +10 -0
  466. data/test_fixtures/EmbeddedEditUrlRequest.json +28 -0
  467. data/test_fixtures/EmbeddedEditUrlResponse.json +8 -0
  468. data/test_fixtures/EmbeddedSignUrlResponse.json +8 -0
  469. data/test_fixtures/ErrorResponse.json +9 -0
  470. data/test_fixtures/EventCallbackHelper.json +50 -0
  471. data/test_fixtures/FileResponse.json +6 -0
  472. data/test_fixtures/OAuthTokenGenerateRequest.json +9 -0
  473. data/test_fixtures/OAuthTokenRefreshRequest.json +6 -0
  474. data/test_fixtures/OAuthTokenResponse.json +15 -0
  475. data/test_fixtures/ReportCreateRequest.json +10 -0
  476. data/test_fixtures/ReportCreateResponse.json +13 -0
  477. data/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +67 -0
  478. data/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +66 -0
  479. data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +252 -0
  480. data/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +60 -0
  481. data/test_fixtures/SignatureRequestGetResponse.json +146 -0
  482. data/test_fixtures/SignatureRequestListResponse.json +102 -0
  483. data/test_fixtures/SignatureRequestRemindRequest.json +5 -0
  484. data/test_fixtures/SignatureRequestSendRequest.json +463 -0
  485. data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +48 -0
  486. data/test_fixtures/SignatureRequestUpdateRequest.json +7 -0
  487. data/test_fixtures/SubFormFieldsPerDocument.json +107 -0
  488. data/test_fixtures/TeamAddMemberRequest.json +6 -0
  489. data/test_fixtures/TeamCreateRequest.json +5 -0
  490. data/test_fixtures/TeamGetResponse.json +34 -0
  491. data/test_fixtures/TeamRemoveMemberRequest.json +7 -0
  492. data/test_fixtures/TeamUpdateRequest.json +5 -0
  493. data/test_fixtures/TemplateAddUserRequest.json +7 -0
  494. data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +118 -0
  495. data/test_fixtures/TemplateCreateEmbeddedDraftResponse.json +9 -0
  496. data/test_fixtures/TemplateGetResponse.json +102 -0
  497. data/test_fixtures/TemplateListResponse.json +143 -0
  498. data/test_fixtures/TemplateRemoveUserRequest.json +6 -0
  499. data/test_fixtures/TemplateUpdateFilesRequest.json +11 -0
  500. data/test_fixtures/TemplateUpdateFilesResponse.json +7 -0
  501. data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +134 -0
  502. data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +67 -0
  503. data/test_fixtures/UnclaimedDraftCreateRequest.json +119 -0
  504. data/test_fixtures/UnclaimedDraftCreateResponse.json +9 -0
  505. data/test_fixtures/UnclaimedDraftEditAndResendRequest.json +15 -0
  506. data/test_fixtures/bulk-send-sample.csv +3 -0
  507. data/test_fixtures/pdf-sample-2.pdf +0 -0
  508. data/test_fixtures/pdf-sample.pdf +0 -0
  509. data/vendor/autoload.php +7 -0
  510. data/vendor/bin/yaml-lint +117 -0
  511. data/vendor/composer/ClassLoader.php +572 -0
  512. data/vendor/composer/InstalledVersions.php +350 -0
  513. data/vendor/composer/LICENSE +21 -0
  514. data/vendor/composer/autoload_classmap.php +10 -0
  515. data/vendor/composer/autoload_files.php +11 -0
  516. data/vendor/composer/autoload_namespaces.php +9 -0
  517. data/vendor/composer/autoload_psr4.php +11 -0
  518. data/vendor/composer/autoload_real.php +80 -0
  519. data/vendor/composer/autoload_static.php +46 -0
  520. data/vendor/composer/installed.json +239 -0
  521. data/vendor/composer/installed.php +50 -0
  522. data/vendor/composer/platform_check.php +26 -0
  523. data/vendor/symfony/deprecation-contracts/.gitignore +3 -0
  524. data/vendor/symfony/deprecation-contracts/CHANGELOG.md +5 -0
  525. data/vendor/symfony/deprecation-contracts/LICENSE +19 -0
  526. data/vendor/symfony/deprecation-contracts/README.md +26 -0
  527. data/vendor/symfony/deprecation-contracts/composer.json +35 -0
  528. data/vendor/symfony/deprecation-contracts/function.php +27 -0
  529. data/vendor/symfony/polyfill-ctype/Ctype.php +232 -0
  530. data/vendor/symfony/polyfill-ctype/LICENSE +19 -0
  531. data/vendor/symfony/polyfill-ctype/README.md +12 -0
  532. data/vendor/symfony/polyfill-ctype/bootstrap.php +50 -0
  533. data/vendor/symfony/polyfill-ctype/bootstrap80.php +46 -0
  534. data/vendor/symfony/polyfill-ctype/composer.json +41 -0
  535. data/vendor/symfony/yaml/CHANGELOG.md +237 -0
  536. data/vendor/symfony/yaml/Command/LintCommand.php +289 -0
  537. data/vendor/symfony/yaml/Dumper.php +140 -0
  538. data/vendor/symfony/yaml/Escaper.php +95 -0
  539. data/vendor/symfony/yaml/Exception/DumpException.php +21 -0
  540. data/vendor/symfony/yaml/Exception/ExceptionInterface.php +21 -0
  541. data/vendor/symfony/yaml/Exception/ParseException.php +132 -0
  542. data/vendor/symfony/yaml/Exception/RuntimeException.php +21 -0
  543. data/vendor/symfony/yaml/Inline.php +812 -0
  544. data/vendor/symfony/yaml/LICENSE +19 -0
  545. data/vendor/symfony/yaml/Parser.php +1305 -0
  546. data/vendor/symfony/yaml/README.md +13 -0
  547. data/vendor/symfony/yaml/Resources/bin/yaml-lint +45 -0
  548. data/vendor/symfony/yaml/Tag/TaggedValue.php +38 -0
  549. data/vendor/symfony/yaml/Unescaper.php +132 -0
  550. data/vendor/symfony/yaml/Yaml.php +100 -0
  551. data/vendor/symfony/yaml/composer.json +42 -0
  552. metadata +650 -0
@@ -0,0 +1,728 @@
1
+ =begin
2
+ #Dropbox Sign API
3
+
4
+ #Dropbox Sign v3 API
5
+
6
+ The version of the OpenAPI document: 3.0.0
7
+ Contact: apisupport@hellosign.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Dropbox
17
+ end
18
+
19
+ module Dropbox::Sign
20
+ class UnclaimedDraftCreateEmbeddedRequest
21
+ # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
22
+ attr_accessor :client_id
23
+
24
+ # The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.
25
+ attr_accessor :requester_email_address
26
+
27
+ # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
28
+ attr_accessor :files
29
+
30
+ # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
31
+ attr_accessor :file_urls
32
+
33
+ # This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
34
+ attr_accessor :allow_ccs
35
+
36
+ # Allows signers to decline to sign a document if `true`. Defaults to `false`.
37
+ attr_accessor :allow_decline
38
+
39
+ # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan and higher.
40
+ attr_accessor :allow_reassign
41
+
42
+ # A list describing the attachments
43
+ attr_accessor :attachments
44
+
45
+ # The email addresses that should be CCed.
46
+ attr_accessor :cc_email_addresses
47
+
48
+ # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
49
+ attr_accessor :custom_fields
50
+
51
+ attr_accessor :editor_options
52
+
53
+ attr_accessor :field_options
54
+
55
+ # Provide users the ability to review/edit the signers.
56
+ attr_accessor :force_signer_page
57
+
58
+ # Provide users the ability to review/edit the subject and message.
59
+ attr_accessor :force_subject_message
60
+
61
+ # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
62
+ attr_accessor :form_field_groups
63
+
64
+ # Conditional Logic rules for fields defined in `form_fields_per_document`.
65
+ attr_accessor :form_field_rules
66
+
67
+ # The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href=\"/docs/openapi/form-fields-per-document\" target=\"_blank\">Using Form Fields per Document</a>.) **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
68
+ attr_accessor :form_fields_per_document
69
+
70
+ # Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
71
+ attr_accessor :hide_text_tags
72
+
73
+ # The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
74
+ attr_accessor :hold_request
75
+
76
+ # The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
77
+ attr_accessor :is_for_embedded_signing
78
+
79
+ # The custom message in the email that will be sent to the signers.
80
+ attr_accessor :message
81
+
82
+ # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
83
+ attr_accessor :metadata
84
+
85
+ # The URL you want signers redirected to after they successfully request a signature.
86
+ attr_accessor :requesting_redirect_url
87
+
88
+ # This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience.
89
+ attr_accessor :show_preview
90
+
91
+ # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
92
+ attr_accessor :show_progress_stepper
93
+
94
+ # Add Signers to your Unclaimed Draft Signature Request.
95
+ attr_accessor :signers
96
+
97
+ attr_accessor :signing_options
98
+
99
+ # The URL you want signers redirected to after they successfully sign.
100
+ attr_accessor :signing_redirect_url
101
+
102
+ # Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
103
+ attr_accessor :skip_me_now
104
+
105
+ # The subject in the email that will be sent to the signers.
106
+ attr_accessor :subject
107
+
108
+ # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
109
+ attr_accessor :test_mode
110
+
111
+ # The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.
112
+ attr_accessor :type
113
+
114
+ # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
115
+ attr_accessor :use_preexisting_fields
116
+
117
+ # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
118
+ attr_accessor :use_text_tags
119
+
120
+ # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
121
+ attr_accessor :populate_auto_fill_fields
122
+
123
+ # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **Note**: This does not correspond to the **expires_at** returned in the response.
124
+ attr_accessor :expires_at
125
+
126
+ class EnumAttributeValidator
127
+ attr_reader :datatype
128
+ attr_reader :allowable_values
129
+
130
+ def initialize(datatype, allowable_values)
131
+ @allowable_values = allowable_values.map do |value|
132
+ case datatype.to_s
133
+ when /Integer/i
134
+ value.to_i
135
+ when /Float/i
136
+ value.to_f
137
+ else
138
+ value
139
+ end
140
+ end
141
+ end
142
+
143
+ def valid?(value)
144
+ !value || allowable_values.include?(value)
145
+ end
146
+ end
147
+
148
+ # Attribute mapping from ruby-style variable name to JSON key.
149
+ def self.attribute_map
150
+ {
151
+ :'client_id' => :'client_id',
152
+ :'requester_email_address' => :'requester_email_address',
153
+ :'files' => :'files',
154
+ :'file_urls' => :'file_urls',
155
+ :'allow_ccs' => :'allow_ccs',
156
+ :'allow_decline' => :'allow_decline',
157
+ :'allow_reassign' => :'allow_reassign',
158
+ :'attachments' => :'attachments',
159
+ :'cc_email_addresses' => :'cc_email_addresses',
160
+ :'custom_fields' => :'custom_fields',
161
+ :'editor_options' => :'editor_options',
162
+ :'field_options' => :'field_options',
163
+ :'force_signer_page' => :'force_signer_page',
164
+ :'force_subject_message' => :'force_subject_message',
165
+ :'form_field_groups' => :'form_field_groups',
166
+ :'form_field_rules' => :'form_field_rules',
167
+ :'form_fields_per_document' => :'form_fields_per_document',
168
+ :'hide_text_tags' => :'hide_text_tags',
169
+ :'hold_request' => :'hold_request',
170
+ :'is_for_embedded_signing' => :'is_for_embedded_signing',
171
+ :'message' => :'message',
172
+ :'metadata' => :'metadata',
173
+ :'requesting_redirect_url' => :'requesting_redirect_url',
174
+ :'show_preview' => :'show_preview',
175
+ :'show_progress_stepper' => :'show_progress_stepper',
176
+ :'signers' => :'signers',
177
+ :'signing_options' => :'signing_options',
178
+ :'signing_redirect_url' => :'signing_redirect_url',
179
+ :'skip_me_now' => :'skip_me_now',
180
+ :'subject' => :'subject',
181
+ :'test_mode' => :'test_mode',
182
+ :'type' => :'type',
183
+ :'use_preexisting_fields' => :'use_preexisting_fields',
184
+ :'use_text_tags' => :'use_text_tags',
185
+ :'populate_auto_fill_fields' => :'populate_auto_fill_fields',
186
+ :'expires_at' => :'expires_at'
187
+ }
188
+ end
189
+
190
+ # Returns all the JSON keys this model knows about
191
+ def self.acceptable_attributes
192
+ attribute_map.values
193
+ end
194
+
195
+ # Returns attribute map of this model + parent
196
+ def self.merged_attributes
197
+ self.attribute_map
198
+ end
199
+
200
+ # Attribute type mapping.
201
+ def self.openapi_types
202
+ {
203
+ :'client_id' => :'String',
204
+ :'requester_email_address' => :'String',
205
+ :'files' => :'Array<File>',
206
+ :'file_urls' => :'Array<String>',
207
+ :'allow_ccs' => :'Boolean',
208
+ :'allow_decline' => :'Boolean',
209
+ :'allow_reassign' => :'Boolean',
210
+ :'attachments' => :'Array<SubAttachment>',
211
+ :'cc_email_addresses' => :'Array<String>',
212
+ :'custom_fields' => :'Array<SubCustomField>',
213
+ :'editor_options' => :'SubEditorOptions',
214
+ :'field_options' => :'SubFieldOptions',
215
+ :'force_signer_page' => :'Boolean',
216
+ :'force_subject_message' => :'Boolean',
217
+ :'form_field_groups' => :'Array<SubFormFieldGroup>',
218
+ :'form_field_rules' => :'Array<SubFormFieldRule>',
219
+ :'form_fields_per_document' => :'Array<SubFormFieldsPerDocumentBase>',
220
+ :'hide_text_tags' => :'Boolean',
221
+ :'hold_request' => :'Boolean',
222
+ :'is_for_embedded_signing' => :'Boolean',
223
+ :'message' => :'String',
224
+ :'metadata' => :'Hash<String, Object>',
225
+ :'requesting_redirect_url' => :'String',
226
+ :'show_preview' => :'Boolean',
227
+ :'show_progress_stepper' => :'Boolean',
228
+ :'signers' => :'Array<SubUnclaimedDraftSigner>',
229
+ :'signing_options' => :'SubSigningOptions',
230
+ :'signing_redirect_url' => :'String',
231
+ :'skip_me_now' => :'Boolean',
232
+ :'subject' => :'String',
233
+ :'test_mode' => :'Boolean',
234
+ :'type' => :'String',
235
+ :'use_preexisting_fields' => :'Boolean',
236
+ :'use_text_tags' => :'Boolean',
237
+ :'populate_auto_fill_fields' => :'Boolean',
238
+ :'expires_at' => :'Integer'
239
+ }
240
+ end
241
+
242
+ # Attribute type mapping of this model + parent
243
+ def self.merged_types
244
+ self.openapi_types
245
+ end
246
+
247
+ # List of attributes with nullable: true
248
+ def self.openapi_nullable
249
+ Set.new([
250
+ :'expires_at'
251
+ ])
252
+ end
253
+
254
+ # Returns list of attributes with nullable: true of this model + parent
255
+ def self.merged_nullable
256
+ self.openapi_nullable
257
+ end
258
+
259
+ # Attempt to instantiate and hydrate a new instance of this class
260
+ # @param [Object] data Data to be converted
261
+ # @return [UnclaimedDraftCreateEmbeddedRequest]
262
+ def self.init(data)
263
+ return ApiClient.default.convert_to_type(
264
+ data,
265
+ "UnclaimedDraftCreateEmbeddedRequest"
266
+ ) || UnclaimedDraftCreateEmbeddedRequest.new
267
+ end
268
+
269
+ # Initializes the object
270
+ # @param [Hash] attributes Model attributes in the form of hash
271
+ def initialize(attributes = {})
272
+ if (!attributes.is_a?(Hash))
273
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest` initialize method"
274
+ end
275
+
276
+ # check to see if the attribute exists and convert string to symbol for hash key
277
+ attributes = attributes.each_with_object({}) { |(k, v), h|
278
+ if (!self.class.merged_attributes.key?(k.to_sym))
279
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
280
+ end
281
+ h[k.to_sym] = v
282
+ }
283
+
284
+ if attributes.key?(:'client_id')
285
+ self.client_id = attributes[:'client_id']
286
+ end
287
+
288
+ if attributes.key?(:'requester_email_address')
289
+ self.requester_email_address = attributes[:'requester_email_address']
290
+ end
291
+
292
+ if attributes.key?(:'files')
293
+ if (value = attributes[:'files']).is_a?(Array)
294
+ self.files = value
295
+ end
296
+ end
297
+
298
+ if attributes.key?(:'file_urls')
299
+ if (value = attributes[:'file_urls']).is_a?(Array)
300
+ self.file_urls = value
301
+ end
302
+ end
303
+
304
+ if attributes.key?(:'allow_ccs')
305
+ self.allow_ccs = attributes[:'allow_ccs']
306
+ else
307
+ self.allow_ccs = true
308
+ end
309
+
310
+ if attributes.key?(:'allow_decline')
311
+ self.allow_decline = attributes[:'allow_decline']
312
+ else
313
+ self.allow_decline = false
314
+ end
315
+
316
+ if attributes.key?(:'allow_reassign')
317
+ self.allow_reassign = attributes[:'allow_reassign']
318
+ else
319
+ self.allow_reassign = false
320
+ end
321
+
322
+ if attributes.key?(:'attachments')
323
+ if (value = attributes[:'attachments']).is_a?(Array)
324
+ self.attachments = value
325
+ end
326
+ end
327
+
328
+ if attributes.key?(:'cc_email_addresses')
329
+ if (value = attributes[:'cc_email_addresses']).is_a?(Array)
330
+ self.cc_email_addresses = value
331
+ end
332
+ end
333
+
334
+ if attributes.key?(:'custom_fields')
335
+ if (value = attributes[:'custom_fields']).is_a?(Array)
336
+ self.custom_fields = value
337
+ end
338
+ end
339
+
340
+ if attributes.key?(:'editor_options')
341
+ self.editor_options = attributes[:'editor_options']
342
+ end
343
+
344
+ if attributes.key?(:'field_options')
345
+ self.field_options = attributes[:'field_options']
346
+ end
347
+
348
+ if attributes.key?(:'force_signer_page')
349
+ self.force_signer_page = attributes[:'force_signer_page']
350
+ else
351
+ self.force_signer_page = false
352
+ end
353
+
354
+ if attributes.key?(:'force_subject_message')
355
+ self.force_subject_message = attributes[:'force_subject_message']
356
+ else
357
+ self.force_subject_message = false
358
+ end
359
+
360
+ if attributes.key?(:'form_field_groups')
361
+ if (value = attributes[:'form_field_groups']).is_a?(Array)
362
+ self.form_field_groups = value
363
+ end
364
+ end
365
+
366
+ if attributes.key?(:'form_field_rules')
367
+ if (value = attributes[:'form_field_rules']).is_a?(Array)
368
+ self.form_field_rules = value
369
+ end
370
+ end
371
+
372
+ if attributes.key?(:'form_fields_per_document')
373
+ if (value = attributes[:'form_fields_per_document']).is_a?(Array)
374
+ self.form_fields_per_document = value
375
+ end
376
+ end
377
+
378
+ if attributes.key?(:'hide_text_tags')
379
+ self.hide_text_tags = attributes[:'hide_text_tags']
380
+ else
381
+ self.hide_text_tags = false
382
+ end
383
+
384
+ if attributes.key?(:'hold_request')
385
+ self.hold_request = attributes[:'hold_request']
386
+ else
387
+ self.hold_request = false
388
+ end
389
+
390
+ if attributes.key?(:'is_for_embedded_signing')
391
+ self.is_for_embedded_signing = attributes[:'is_for_embedded_signing']
392
+ else
393
+ self.is_for_embedded_signing = false
394
+ end
395
+
396
+ if attributes.key?(:'message')
397
+ self.message = attributes[:'message']
398
+ end
399
+
400
+ if attributes.key?(:'metadata')
401
+ if (value = attributes[:'metadata']).is_a?(Hash)
402
+ self.metadata = value
403
+ end
404
+ end
405
+
406
+ if attributes.key?(:'requesting_redirect_url')
407
+ self.requesting_redirect_url = attributes[:'requesting_redirect_url']
408
+ end
409
+
410
+ if attributes.key?(:'show_preview')
411
+ self.show_preview = attributes[:'show_preview']
412
+ end
413
+
414
+ if attributes.key?(:'show_progress_stepper')
415
+ self.show_progress_stepper = attributes[:'show_progress_stepper']
416
+ else
417
+ self.show_progress_stepper = true
418
+ end
419
+
420
+ if attributes.key?(:'signers')
421
+ if (value = attributes[:'signers']).is_a?(Array)
422
+ self.signers = value
423
+ end
424
+ end
425
+
426
+ if attributes.key?(:'signing_options')
427
+ self.signing_options = attributes[:'signing_options']
428
+ end
429
+
430
+ if attributes.key?(:'signing_redirect_url')
431
+ self.signing_redirect_url = attributes[:'signing_redirect_url']
432
+ end
433
+
434
+ if attributes.key?(:'skip_me_now')
435
+ self.skip_me_now = attributes[:'skip_me_now']
436
+ else
437
+ self.skip_me_now = false
438
+ end
439
+
440
+ if attributes.key?(:'subject')
441
+ self.subject = attributes[:'subject']
442
+ end
443
+
444
+ if attributes.key?(:'test_mode')
445
+ self.test_mode = attributes[:'test_mode']
446
+ else
447
+ self.test_mode = false
448
+ end
449
+
450
+ if attributes.key?(:'type')
451
+ self.type = attributes[:'type']
452
+ else
453
+ self.type = 'request_signature'
454
+ end
455
+
456
+ if attributes.key?(:'use_preexisting_fields')
457
+ self.use_preexisting_fields = attributes[:'use_preexisting_fields']
458
+ else
459
+ self.use_preexisting_fields = false
460
+ end
461
+
462
+ if attributes.key?(:'use_text_tags')
463
+ self.use_text_tags = attributes[:'use_text_tags']
464
+ else
465
+ self.use_text_tags = false
466
+ end
467
+
468
+ if attributes.key?(:'populate_auto_fill_fields')
469
+ self.populate_auto_fill_fields = attributes[:'populate_auto_fill_fields']
470
+ else
471
+ self.populate_auto_fill_fields = false
472
+ end
473
+
474
+ if attributes.key?(:'expires_at')
475
+ self.expires_at = attributes[:'expires_at']
476
+ end
477
+ end
478
+
479
+ # Show invalid properties with the reasons. Usually used together with valid?
480
+ # @return Array for valid properties with the reasons
481
+ def list_invalid_properties
482
+ invalid_properties = Array.new
483
+ if @client_id.nil?
484
+ invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
485
+ end
486
+
487
+ if @requester_email_address.nil?
488
+ invalid_properties.push('invalid value for "requester_email_address", requester_email_address cannot be nil.')
489
+ end
490
+
491
+ if !@message.nil? && @message.to_s.length > 5000
492
+ invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 5000.')
493
+ end
494
+
495
+ if !@subject.nil? && @subject.to_s.length > 200
496
+ invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 200.')
497
+ end
498
+
499
+ invalid_properties
500
+ end
501
+
502
+ # Check to see if the all the properties in the model are valid
503
+ # @return true if the model is valid
504
+ def valid?
505
+ return false if @client_id.nil?
506
+ return false if @requester_email_address.nil?
507
+ return false if !@message.nil? && @message.to_s.length > 5000
508
+ return false if !@subject.nil? && @subject.to_s.length > 200
509
+ type_validator = EnumAttributeValidator.new('String', ["send_document", "request_signature"])
510
+ return false unless type_validator.valid?(@type)
511
+ true
512
+ end
513
+
514
+ # Custom attribute writer method with validation
515
+ # @param [Object] message Value to be assigned
516
+ def message=(message)
517
+ if !message.nil? && message.to_s.length > 5000
518
+ fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 5000.'
519
+ end
520
+
521
+ @message = message
522
+ end
523
+
524
+ # Custom attribute writer method with validation
525
+ # @param [Object] metadata Value to be assigned
526
+ def metadata=(metadata)
527
+ @metadata = metadata
528
+ end
529
+
530
+ # Custom attribute writer method with validation
531
+ # @param [Object] subject Value to be assigned
532
+ def subject=(subject)
533
+ if !subject.nil? && subject.to_s.length > 200
534
+ fail ArgumentError, 'invalid value for "subject", the character length must be smaller than or equal to 200.'
535
+ end
536
+
537
+ @subject = subject
538
+ end
539
+
540
+ # Custom attribute writer method checking allowed values (enum).
541
+ # @param [Object] type Object to be assigned
542
+ def type=(type)
543
+ validator = EnumAttributeValidator.new('String', ["send_document", "request_signature"])
544
+ unless validator.valid?(type)
545
+ fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
546
+ end
547
+ @type = type
548
+ end
549
+
550
+ # Checks equality by comparing each attribute.
551
+ # @param [Object] Object to be compared
552
+ def ==(o)
553
+ return true if self.equal?(o)
554
+ self.class == o.class &&
555
+ client_id == o.client_id &&
556
+ requester_email_address == o.requester_email_address &&
557
+ files == o.files &&
558
+ file_urls == o.file_urls &&
559
+ allow_ccs == o.allow_ccs &&
560
+ allow_decline == o.allow_decline &&
561
+ allow_reassign == o.allow_reassign &&
562
+ attachments == o.attachments &&
563
+ cc_email_addresses == o.cc_email_addresses &&
564
+ custom_fields == o.custom_fields &&
565
+ editor_options == o.editor_options &&
566
+ field_options == o.field_options &&
567
+ force_signer_page == o.force_signer_page &&
568
+ force_subject_message == o.force_subject_message &&
569
+ form_field_groups == o.form_field_groups &&
570
+ form_field_rules == o.form_field_rules &&
571
+ form_fields_per_document == o.form_fields_per_document &&
572
+ hide_text_tags == o.hide_text_tags &&
573
+ hold_request == o.hold_request &&
574
+ is_for_embedded_signing == o.is_for_embedded_signing &&
575
+ message == o.message &&
576
+ metadata == o.metadata &&
577
+ requesting_redirect_url == o.requesting_redirect_url &&
578
+ show_preview == o.show_preview &&
579
+ show_progress_stepper == o.show_progress_stepper &&
580
+ signers == o.signers &&
581
+ signing_options == o.signing_options &&
582
+ signing_redirect_url == o.signing_redirect_url &&
583
+ skip_me_now == o.skip_me_now &&
584
+ subject == o.subject &&
585
+ test_mode == o.test_mode &&
586
+ type == o.type &&
587
+ use_preexisting_fields == o.use_preexisting_fields &&
588
+ use_text_tags == o.use_text_tags &&
589
+ populate_auto_fill_fields == o.populate_auto_fill_fields &&
590
+ expires_at == o.expires_at
591
+ end
592
+
593
+ # @see the `==` method
594
+ # @param [Object] Object to be compared
595
+ def eql?(o)
596
+ self == o
597
+ end
598
+
599
+ # Calculates hash code according to all attributes.
600
+ # @return [Integer] Hash code
601
+ def hash
602
+ [client_id, requester_email_address, files, file_urls, allow_ccs, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, editor_options, field_options, force_signer_page, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, hold_request, is_for_embedded_signing, message, metadata, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, type, use_preexisting_fields, use_text_tags, populate_auto_fill_fields, expires_at].hash
603
+ end
604
+
605
+ # Builds the object from hash
606
+ # @param [Hash] attributes Model attributes in the form of hash
607
+ # @return [Object] Returns the model itself
608
+ def self.build_from_hash(attributes)
609
+ new.build_from_hash(attributes)
610
+ end
611
+
612
+ # Builds the object from hash
613
+ # @param [Hash] attributes Model attributes in the form of hash
614
+ # @return [Object] Returns the model itself
615
+ def build_from_hash(attributes)
616
+ return nil unless attributes.is_a?(Hash)
617
+ attribute_map = self.class.merged_attributes
618
+
619
+ self.class.merged_types.each_pair do |key, type|
620
+ if type =~ /\AArray<(.*)>/i
621
+ # check to ensure the input is an array given that the attribute
622
+ # is documented as an array but the input is not
623
+ if attributes[attribute_map[key]].is_a?(Array)
624
+ self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
625
+ end
626
+ elsif !attributes[attribute_map[key]].nil?
627
+ self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
628
+ end
629
+ end
630
+
631
+ self
632
+ end
633
+
634
+ # Deserializes the data based on type
635
+ # @param string type Data type
636
+ # @param string value Value to be deserialized
637
+ # @return [Object] Deserialized data
638
+ def _deserialize(type, value)
639
+ case type.to_sym
640
+ when :Time
641
+ Time.parse(value)
642
+ when :Date
643
+ Date.parse(value)
644
+ when :String
645
+ value.to_s
646
+ when :Integer
647
+ value.to_i
648
+ when :Float
649
+ value.to_f
650
+ when :Boolean
651
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
652
+ true
653
+ else
654
+ false
655
+ end
656
+ when :File
657
+ value
658
+ when :Object
659
+ # generic object (usually a Hash), return directly
660
+ value
661
+ when /\AArray<(?<inner_type>.+)>\z/
662
+ inner_type = Regexp.last_match[:inner_type]
663
+ value.map { |v| _deserialize(inner_type, v) }
664
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
665
+ k_type = Regexp.last_match[:k_type]
666
+ v_type = Regexp.last_match[:v_type]
667
+ {}.tap do |hash|
668
+ value.each do |k, v|
669
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
670
+ end
671
+ end
672
+ else # model
673
+ # models (e.g. Pet)
674
+ klass = Dropbox::Sign.const_get(type)
675
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
676
+ end
677
+ end
678
+
679
+ # Returns the string representation of the object
680
+ # @return [String] String presentation of the object
681
+ def to_s
682
+ to_hash.to_s
683
+ end
684
+
685
+ # to_body is an alias to to_hash (backward compatibility)
686
+ # @return [Hash] Returns the object in the form of hash
687
+ def to_body
688
+ to_hash
689
+ end
690
+
691
+ # Returns the object in the form of hash
692
+ # @return [Hash] Returns the object in the form of hash
693
+ def to_hash(include_nil = true)
694
+ hash = {}
695
+ self.class.merged_attributes.each_pair do |attr, param|
696
+ value = self.send(attr)
697
+ if value.nil?
698
+ next unless include_nil
699
+ is_nullable = self.class.merged_nullable.include?(attr)
700
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
701
+ end
702
+
703
+ hash[param] = _to_hash(value, include_nil)
704
+ end
705
+ hash
706
+ end
707
+
708
+ # Outputs non-array value in the form of hash
709
+ # For object, use to_hash. Otherwise, just return the value
710
+ # @param [Object] value Any valid value
711
+ # @return [Hash] Returns the value in the form of hash
712
+ def _to_hash(value, include_nil = true)
713
+ if value.is_a?(Array)
714
+ value.compact.map { |v| _to_hash(v, include_nil) }
715
+ elsif value.is_a?(Hash)
716
+ {}.tap do |hash|
717
+ value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
718
+ end
719
+ elsif value.respond_to? :to_hash
720
+ value.to_hash(include_nil)
721
+ else
722
+ value
723
+ end
724
+ end
725
+
726
+ end
727
+
728
+ end