docusign_esign 1.0.2 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (496) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile.lock +16 -14
  3. data/README.md +44 -19
  4. data/docusign_esign.gemspec +5 -5
  5. data/lib/.DS_Store +0 -0
  6. data/lib/docusign_esign.rb +69 -6
  7. data/lib/docusign_esign/.DS_Store +0 -0
  8. data/lib/docusign_esign/api/accounts_api.rb +786 -74
  9. data/lib/docusign_esign/api/billing_api.rb +51 -2
  10. data/lib/docusign_esign/api/bulk_envelopes_api.rb +3 -1
  11. data/lib/docusign_esign/api/comments_api.rb +89 -0
  12. data/lib/docusign_esign/api/connect_api.rb +0 -151
  13. data/lib/docusign_esign/api/envelopes_api.rb +578 -195
  14. data/lib/docusign_esign/api/folders_api.rb +5 -14
  15. data/lib/docusign_esign/api/groups_api.rb +0 -4
  16. data/lib/docusign_esign/api/notary_api.rb +89 -0
  17. data/lib/docusign_esign/api/power_forms_api.rb +4 -0
  18. data/lib/docusign_esign/api/templates_api.rb +465 -6
  19. data/lib/docusign_esign/api/trust_service_providers_api.rb +73 -0
  20. data/lib/docusign_esign/api/users_api.rb +89 -10
  21. data/{tests → lib/docusign_esign/client}/.DS_Store +0 -0
  22. data/lib/docusign_esign/{api_client.rb → client/api_client.rb} +187 -34
  23. data/lib/docusign_esign/{api_error.rb → client/api_error.rb} +0 -0
  24. data/lib/docusign_esign/client/auth/oauth.rb +1061 -0
  25. data/lib/docusign_esign/configuration.rb +7 -0
  26. data/lib/docusign_esign/models/account_address.rb +1 -1
  27. data/lib/docusign_esign/models/account_billing_plan_response.rb +10 -1
  28. data/lib/docusign_esign/models/account_identity_verification_response.rb +190 -0
  29. data/lib/docusign_esign/models/{view_link_request.rb → account_identity_verification_step.rb} +14 -14
  30. data/lib/docusign_esign/models/account_identity_verification_workflow.rb +210 -0
  31. data/lib/docusign_esign/models/account_information.rb +11 -1
  32. data/lib/docusign_esign/models/account_minimum_password_length.rb +198 -0
  33. data/lib/docusign_esign/models/{post_transactions_response.rb → account_password_expire_password_days.rb} +14 -14
  34. data/lib/docusign_esign/models/account_password_lockout_duration_minutes.rb +198 -0
  35. data/lib/docusign_esign/models/account_password_lockout_duration_type.rb +190 -0
  36. data/lib/docusign_esign/models/account_password_minimum_password_age_days.rb +198 -0
  37. data/lib/docusign_esign/models/account_password_questions_required.rb +198 -0
  38. data/lib/docusign_esign/models/account_password_rules.rb +371 -0
  39. data/lib/docusign_esign/models/account_password_strength_type.rb +190 -0
  40. data/lib/docusign_esign/models/account_password_strength_type_option.rb +248 -0
  41. data/lib/docusign_esign/models/account_role_settings.rb +39 -1
  42. data/lib/docusign_esign/models/account_seals.rb +190 -0
  43. data/lib/docusign_esign/models/agent.rb +33 -3
  44. data/lib/docusign_esign/models/approve.rb +25 -3
  45. data/lib/docusign_esign/models/authentication_status.rb +10 -1
  46. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  47. data/lib/docusign_esign/models/billing_plan_information.rb +10 -1
  48. data/lib/docusign_esign/models/billing_plan_update_response.rb +11 -1
  49. data/lib/docusign_esign/models/bulk_recipient.rb +1 -1
  50. data/lib/docusign_esign/models/carbon_copy.rb +53 -3
  51. data/lib/docusign_esign/models/certified_delivery.rb +53 -3
  52. data/lib/docusign_esign/models/checkbox.rb +25 -3
  53. data/lib/docusign_esign/models/chunked_upload_response.rb +21 -1
  54. data/lib/docusign_esign/models/company.rb +25 -3
  55. data/lib/docusign_esign/models/complete_sign_hash_response.rb +210 -0
  56. data/lib/docusign_esign/models/complete_sign_request.rb +220 -0
  57. data/lib/docusign_esign/models/composite_template.rb +1 -1
  58. data/lib/docusign_esign/models/connect_custom_configuration.rb +14 -4
  59. data/lib/docusign_esign/models/consumer_disclosure.rb +19 -1
  60. data/lib/docusign_esign/models/contact.rb +13 -1
  61. data/lib/docusign_esign/models/contact_phone_number.rb +198 -0
  62. data/lib/docusign_esign/models/credential.rb +198 -0
  63. data/lib/docusign_esign/models/{offline_attributes.rb → custom_field.rb} +65 -44
  64. data/lib/docusign_esign/models/date.rb +26 -4
  65. data/lib/docusign_esign/models/date_signed.rb +25 -3
  66. data/lib/docusign_esign/models/{post_transactions_request.rb → date_stamp_properties.rb} +26 -26
  67. data/lib/docusign_esign/models/decline.rb +25 -3
  68. data/lib/docusign_esign/models/dob_information_input.rb +1 -1
  69. data/lib/docusign_esign/models/document.rb +31 -2
  70. data/lib/docusign_esign/models/document_fields_information.rb +1 -1
  71. data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +278 -0
  72. data/lib/docusign_esign/models/document_html_definition.rb +290 -0
  73. data/lib/docusign_esign/models/document_html_definition_original.rb +207 -0
  74. data/lib/docusign_esign/models/document_html_definition_originals.rb +190 -0
  75. data/lib/docusign_esign/models/document_html_definitions.rb +190 -0
  76. data/lib/docusign_esign/models/document_html_display_anchor.rb +237 -0
  77. data/lib/docusign_esign/models/document_html_display_settings.rb +287 -0
  78. data/lib/docusign_esign/models/document_security_store.rb +214 -0
  79. data/lib/docusign_esign/models/document_update_info.rb +248 -0
  80. data/lib/docusign_esign/models/editor.rb +33 -3
  81. data/lib/docusign_esign/models/email.rb +26 -4
  82. data/lib/docusign_esign/models/email_address.rb +35 -3
  83. data/lib/docusign_esign/models/email_settings.rb +1 -1
  84. data/lib/docusign_esign/models/envelope.rb +32 -2
  85. data/lib/docusign_esign/models/envelope_definition.rb +33 -3
  86. data/lib/docusign_esign/models/envelope_document.rb +11 -21
  87. data/lib/docusign_esign/models/envelope_id.rb +25 -3
  88. data/lib/docusign_esign/models/envelope_template.rb +32 -2
  89. data/lib/docusign_esign/models/envelope_template_definition.rb +11 -1
  90. data/lib/docusign_esign/models/envelope_template_result.rb +42 -2
  91. data/lib/docusign_esign/models/envelopes_information.rb +21 -1
  92. data/lib/docusign_esign/models/first_name.rb +35 -3
  93. data/lib/docusign_esign/models/formula_tab.rb +36 -4
  94. data/lib/docusign_esign/models/full_name.rb +35 -3
  95. data/lib/docusign_esign/models/id_check_information_input.rb +1 -1
  96. data/lib/docusign_esign/models/in_person_signer.rb +45 -3
  97. data/lib/docusign_esign/models/initial_here.rb +26 -4
  98. data/lib/docusign_esign/models/intermediary.rb +33 -3
  99. data/lib/docusign_esign/models/jurisdiction.rb +278 -0
  100. data/lib/docusign_esign/models/last_name.rb +35 -3
  101. data/lib/docusign_esign/models/list.rb +25 -3
  102. data/lib/docusign_esign/models/new_account_definition.rb +10 -1
  103. data/lib/docusign_esign/models/notarize.rb +448 -0
  104. data/lib/docusign_esign/models/notary_host.rb +12 -21
  105. data/lib/docusign_esign/models/notary_journal.rb +236 -0
  106. data/lib/docusign_esign/models/notary_journal_credible_witness.rb +208 -0
  107. data/lib/docusign_esign/models/notary_journal_list.rb +250 -0
  108. data/lib/docusign_esign/models/notary_journal_meta_data.rb +220 -0
  109. data/lib/docusign_esign/models/note.rb +25 -3
  110. data/lib/docusign_esign/models/number.rb +26 -4
  111. data/lib/docusign_esign/models/payment_details.rb +53 -1
  112. data/lib/docusign_esign/models/payment_gateway_account.rb +218 -0
  113. data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +190 -0
  114. data/lib/docusign_esign/models/payment_processor_information.rb +207 -0
  115. data/lib/docusign_esign/models/power_form.rb +11 -1
  116. data/lib/docusign_esign/models/power_form_recipient.rb +1 -1
  117. data/lib/docusign_esign/models/radio.rb +2 -2
  118. data/lib/docusign_esign/models/radio_group.rb +34 -4
  119. data/lib/docusign_esign/models/recipient_signature_provider.rb +21 -1
  120. data/lib/docusign_esign/models/recipients.rb +28 -4
  121. data/lib/docusign_esign/models/revision.rb +228 -0
  122. data/lib/docusign_esign/models/seal.rb +200 -0
  123. data/lib/docusign_esign/models/seal_identifier.rb +198 -0
  124. data/lib/docusign_esign/models/seal_sign.rb +560 -0
  125. data/lib/docusign_esign/models/sender.rb +198 -0
  126. data/lib/docusign_esign/models/sender_email_notifications.rb +21 -1
  127. data/lib/docusign_esign/models/sign_hash_document.rb +250 -0
  128. data/lib/docusign_esign/models/sign_hash_session_info_response.rb +248 -0
  129. data/lib/docusign_esign/models/sign_here.rb +45 -4
  130. data/lib/docusign_esign/models/sign_session_info_request.rb +208 -0
  131. data/lib/docusign_esign/models/signature_data_info.rb +207 -0
  132. data/lib/docusign_esign/models/signer.rb +54 -4
  133. data/lib/docusign_esign/models/signer_attachment.rb +26 -4
  134. data/lib/docusign_esign/models/signer_email_notifications.rb +21 -1
  135. data/lib/docusign_esign/models/smart_section.rb +505 -0
  136. data/lib/docusign_esign/models/smart_section_anchor_position.rb +208 -0
  137. data/lib/docusign_esign/models/smart_section_collapsible_display_settings.rb +278 -0
  138. data/lib/docusign_esign/models/smart_section_display_settings.rb +287 -0
  139. data/lib/docusign_esign/models/ssn.rb +26 -4
  140. data/lib/docusign_esign/models/supported_languages.rb +190 -0
  141. data/lib/docusign_esign/models/tab_metadata.rb +63 -4
  142. data/lib/docusign_esign/models/tabs.rb +27 -3
  143. data/lib/docusign_esign/models/template_recipients.rb +28 -4
  144. data/lib/docusign_esign/models/template_role.rb +15 -3
  145. data/lib/docusign_esign/models/template_tabs.rb +27 -3
  146. data/lib/docusign_esign/models/text.rb +26 -4
  147. data/lib/docusign_esign/models/time_stamp_field.rb +207 -0
  148. data/lib/docusign_esign/models/title.rb +25 -3
  149. data/lib/docusign_esign/models/tsp_health_check_request.rb +230 -0
  150. data/lib/docusign_esign/models/tsp_health_check_status_description.rb +238 -0
  151. data/lib/docusign_esign/models/update_transaction_request.rb +208 -0
  152. data/lib/docusign_esign/models/update_transaction_response.rb +188 -0
  153. data/lib/docusign_esign/models/usage_history.rb +1 -1
  154. data/lib/docusign_esign/models/user.rb +220 -0
  155. data/lib/docusign_esign/models/user_account_management_granular_information.rb +77 -1
  156. data/lib/docusign_esign/models/user_info_response.rb +225 -0
  157. data/lib/docusign_esign/models/user_information.rb +46 -6
  158. data/lib/docusign_esign/models/user_password_rules.rb +197 -0
  159. data/lib/docusign_esign/models/user_signature.rb +83 -4
  160. data/lib/docusign_esign/models/view.rb +25 -3
  161. data/lib/docusign_esign/models/watermark.rb +268 -0
  162. data/lib/docusign_esign/models/witness.rb +812 -0
  163. data/lib/docusign_esign/models/zip.rb +26 -4
  164. data/lib/docusign_esign/version.rb +1 -1
  165. data/tests/Gemfile +1 -1
  166. data/tests/Gemfile.lock +24 -20
  167. data/tests/{rsa_keys → docs}/private.pem +0 -0
  168. data/tests/spec/unit_tests_spec.rb +6 -8
  169. data/tests/spec/unit_tests_using_jwt_spec.rb +37 -35
  170. metadata +122 -672
  171. data/spec/api/accounts_api_spec.rb +0 -556
  172. data/spec/api/authentication_api_spec.rb +0 -125
  173. data/spec/api/billing_api_spec.rb +0 -178
  174. data/spec/api/bulk_envelopes_api_spec.rb +0 -110
  175. data/spec/api/cloud_storage_api_spec.rb +0 -146
  176. data/spec/api/connect_api_spec.rb +0 -261
  177. data/spec/api/custom_tabs_api_spec.rb +0 -100
  178. data/spec/api/diagnostics_api_spec.rb +0 -114
  179. data/spec/api/envelopes_api_spec.rb +0 -1171
  180. data/spec/api/folders_api_spec.rb +0 -107
  181. data/spec/api/groups_api_spec.rb +0 -174
  182. data/spec/api/power_forms_api_spec.rb +0 -144
  183. data/spec/api/signing_groups_api_spec.rb +0 -155
  184. data/spec/api/templates_api_spec.rb +0 -649
  185. data/spec/api/users_api_spec.rb +0 -442
  186. data/spec/api/workspaces_api_spec.rb +0 -201
  187. data/spec/api_client_spec.rb +0 -225
  188. data/spec/configuration_spec.rb +0 -41
  189. data/spec/models/account_address_spec.rb +0 -107
  190. data/spec/models/account_billing_plan_response_spec.rb +0 -71
  191. data/spec/models/account_billing_plan_spec.rb +0 -155
  192. data/spec/models/account_information_spec.rb +0 -221
  193. data/spec/models/account_role_settings_spec.rb +0 -419
  194. data/spec/models/account_settings_information_spec.rb +0 -41
  195. data/spec/models/account_shared_access_spec.rb +0 -89
  196. data/spec/models/account_signature_provider_option_spec.rb +0 -53
  197. data/spec/models/account_signature_provider_spec.rb +0 -77
  198. data/spec/models/account_signature_providers_spec.rb +0 -41
  199. data/spec/models/add_on_spec.rb +0 -59
  200. data/spec/models/address_information_input_spec.rb +0 -53
  201. data/spec/models/address_information_spec.rb +0 -83
  202. data/spec/models/address_information_v2_spec.rb +0 -83
  203. data/spec/models/agent_spec.rb +0 -287
  204. data/spec/models/api_request_log_spec.rb +0 -59
  205. data/spec/models/api_request_logs_result_spec.rb +0 -41
  206. data/spec/models/app_store_product_spec.rb +0 -47
  207. data/spec/models/app_store_receipt_spec.rb +0 -47
  208. data/spec/models/approve_spec.rb +0 -233
  209. data/spec/models/attachment_spec.rb +0 -77
  210. data/spec/models/authentication_method_spec.rb +0 -59
  211. data/spec/models/authentication_status_spec.rb +0 -137
  212. data/spec/models/bcc_email_address_spec.rb +0 -47
  213. data/spec/models/billing_charge_response_spec.rb +0 -41
  214. data/spec/models/billing_charge_spec.rb +0 -113
  215. data/spec/models/billing_discount_spec.rb +0 -53
  216. data/spec/models/billing_invoice_item_spec.rb +0 -65
  217. data/spec/models/billing_invoice_spec.rb +0 -95
  218. data/spec/models/billing_invoices_response_spec.rb +0 -53
  219. data/spec/models/billing_invoices_summary_spec.rb +0 -53
  220. data/spec/models/billing_payment_item_spec.rb +0 -65
  221. data/spec/models/billing_payment_request_spec.rb +0 -41
  222. data/spec/models/billing_payment_response_spec.rb +0 -41
  223. data/spec/models/billing_payment_spec.rb +0 -53
  224. data/spec/models/billing_payments_response_spec.rb +0 -53
  225. data/spec/models/billing_plan_information_spec.rb +0 -125
  226. data/spec/models/billing_plan_preview_spec.rb +0 -71
  227. data/spec/models/billing_plan_response_spec.rb +0 -47
  228. data/spec/models/billing_plan_spec.rb +0 -125
  229. data/spec/models/billing_plan_update_response_spec.rb +0 -77
  230. data/spec/models/billing_plans_response_spec.rb +0 -41
  231. data/spec/models/billing_price_spec.rb +0 -53
  232. data/spec/models/brand_email_content_spec.rb +0 -59
  233. data/spec/models/brand_link_spec.rb +0 -59
  234. data/spec/models/brand_logos_spec.rb +0 -53
  235. data/spec/models/brand_request_spec.rb +0 -41
  236. data/spec/models/brand_resource_urls_spec.rb +0 -59
  237. data/spec/models/brand_resources_list_spec.rb +0 -41
  238. data/spec/models/brand_resources_spec.rb +0 -77
  239. data/spec/models/brand_spec.rb +0 -113
  240. data/spec/models/brands_request_spec.rb +0 -41
  241. data/spec/models/brands_response_spec.rb +0 -53
  242. data/spec/models/bulk_envelope_spec.rb +0 -89
  243. data/spec/models/bulk_envelope_status_spec.rb +0 -119
  244. data/spec/models/bulk_envelopes_response_spec.rb +0 -77
  245. data/spec/models/bulk_recipient_signature_provider_spec.rb +0 -47
  246. data/spec/models/bulk_recipient_spec.rb +0 -95
  247. data/spec/models/bulk_recipient_tab_label_spec.rb +0 -47
  248. data/spec/models/bulk_recipients_request_spec.rb +0 -41
  249. data/spec/models/bulk_recipients_response_spec.rb +0 -77
  250. data/spec/models/bulk_recipients_summary_response_spec.rb +0 -59
  251. data/spec/models/bulk_recipients_update_response_spec.rb +0 -41
  252. data/spec/models/captive_recipient_information_spec.rb +0 -41
  253. data/spec/models/captive_recipient_spec.rb +0 -59
  254. data/spec/models/carbon_copy_spec.rb +0 -287
  255. data/spec/models/certified_delivery_spec.rb +0 -287
  256. data/spec/models/checkbox_spec.rb +0 -215
  257. data/spec/models/chunked_upload_part_spec.rb +0 -47
  258. data/spec/models/chunked_upload_request_spec.rb +0 -47
  259. data/spec/models/chunked_upload_response_spec.rb +0 -77
  260. data/spec/models/cloud_storage_provider_spec.rb +0 -65
  261. data/spec/models/cloud_storage_providers_spec.rb +0 -41
  262. data/spec/models/company_spec.rb +0 -269
  263. data/spec/models/composite_template_spec.rb +0 -65
  264. data/spec/models/connect_config_results_spec.rb +0 -47
  265. data/spec/models/connect_custom_configuration_spec.rb +0 -161
  266. data/spec/models/connect_debug_log_spec.rb +0 -65
  267. data/spec/models/connect_failure_filter_spec.rb +0 -47
  268. data/spec/models/connect_failure_result_spec.rb +0 -65
  269. data/spec/models/connect_failure_results_spec.rb +0 -41
  270. data/spec/models/connect_log_spec.rb +0 -143
  271. data/spec/models/connect_logs_spec.rb +0 -59
  272. data/spec/models/console_view_request_spec.rb +0 -47
  273. data/spec/models/consumer_disclosure_spec.rb +0 -215
  274. data/spec/models/contact_get_response_spec.rb +0 -77
  275. data/spec/models/contact_mod_request_spec.rb +0 -41
  276. data/spec/models/contact_spec.rb +0 -89
  277. data/spec/models/contact_update_response_spec.rb +0 -41
  278. data/spec/models/correct_view_request_spec.rb +0 -47
  279. data/spec/models/country_spec.rb +0 -59
  280. data/spec/models/credit_card_information_spec.rb +0 -71
  281. data/spec/models/credit_card_types_spec.rb +0 -41
  282. data/spec/models/currency_feature_set_price_spec.rb +0 -65
  283. data/spec/models/currency_plan_price_spec.rb +0 -71
  284. data/spec/models/custom_field_v2_spec.rb +0 -77
  285. data/spec/models/custom_fields_envelope_spec.rb +0 -47
  286. data/spec/models/custom_fields_spec.rb +0 -47
  287. data/spec/models/custom_settings_information_spec.rb +0 -41
  288. data/spec/models/date_signed_spec.rb +0 -227
  289. data/spec/models/date_spec.rb +0 -305
  290. data/spec/models/decline_spec.rb +0 -239
  291. data/spec/models/diagnostics_settings_information_spec.rb +0 -53
  292. data/spec/models/dob_information_input_spec.rb +0 -53
  293. data/spec/models/document_fields_information_spec.rb +0 -41
  294. data/spec/models/document_spec.rb +0 -155
  295. data/spec/models/document_template_list_spec.rb +0 -41
  296. data/spec/models/document_template_spec.rb +0 -65
  297. data/spec/models/document_visibility_list_spec.rb +0 -41
  298. data/spec/models/document_visibility_spec.rb +0 -65
  299. data/spec/models/e_note_configuration_spec.rb +0 -65
  300. data/spec/models/editor_spec.rb +0 -281
  301. data/spec/models/email_address_spec.rb +0 -221
  302. data/spec/models/email_settings_spec.rb +0 -53
  303. data/spec/models/email_spec.rb +0 -305
  304. data/spec/models/envelope_attachment_spec.rb +0 -71
  305. data/spec/models/envelope_attachments_request_spec.rb +0 -41
  306. data/spec/models/envelope_attachments_result_spec.rb +0 -41
  307. data/spec/models/envelope_audit_event_response_spec.rb +0 -41
  308. data/spec/models/envelope_audit_event_spec.rb +0 -41
  309. data/spec/models/envelope_definition_spec.rb +0 -371
  310. data/spec/models/envelope_document_spec.rb +0 -137
  311. data/spec/models/envelope_documents_result_spec.rb +0 -47
  312. data/spec/models/envelope_event_spec.rb +0 -47
  313. data/spec/models/envelope_form_data_spec.rb +0 -71
  314. data/spec/models/envelope_id_spec.rb +0 -221
  315. data/spec/models/envelope_ids_request_spec.rb +0 -47
  316. data/spec/models/envelope_notification_request_spec.rb +0 -53
  317. data/spec/models/envelope_spec.rb +0 -317
  318. data/spec/models/envelope_summary_spec.rb +0 -59
  319. data/spec/models/envelope_template_definition_spec.rb +0 -125
  320. data/spec/models/envelope_template_result_spec.rb +0 -401
  321. data/spec/models/envelope_template_results_spec.rb +0 -83
  322. data/spec/models/envelope_template_spec.rb +0 -329
  323. data/spec/models/envelope_transaction_status_spec.rb +0 -59
  324. data/spec/models/envelope_update_summary_spec.rb +0 -83
  325. data/spec/models/envelopes_information_spec.rb +0 -83
  326. data/spec/models/error_details_spec.rb +0 -47
  327. data/spec/models/event_notification_spec.rb +0 -125
  328. data/spec/models/event_result_spec.rb +0 -59
  329. data/spec/models/expirations_spec.rb +0 -53
  330. data/spec/models/external_doc_service_error_details_spec.rb +0 -53
  331. data/spec/models/external_file_spec.rb +0 -83
  332. data/spec/models/external_folder_spec.rb +0 -95
  333. data/spec/models/feature_set_spec.rb +0 -89
  334. data/spec/models/file_type_list_spec.rb +0 -41
  335. data/spec/models/file_type_spec.rb +0 -47
  336. data/spec/models/filter_spec.rb +0 -101
  337. data/spec/models/first_name_spec.rb +0 -221
  338. data/spec/models/folder_item_response_spec.rb +0 -77
  339. data/spec/models/folder_item_spec.rb +0 -161
  340. data/spec/models/folder_item_v2_spec.rb +0 -155
  341. data/spec/models/folder_items_response_spec.rb +0 -77
  342. data/spec/models/folder_spec.rb +0 -107
  343. data/spec/models/folders_request_spec.rb +0 -47
  344. data/spec/models/folders_response_spec.rb +0 -41
  345. data/spec/models/forgotten_password_information_spec.rb +0 -83
  346. data/spec/models/formula_tab_spec.rb +0 -329
  347. data/spec/models/full_name_spec.rb +0 -221
  348. data/spec/models/group_information_spec.rb +0 -77
  349. data/spec/models/group_spec.rb +0 -71
  350. data/spec/models/id_check_information_input_spec.rb +0 -59
  351. data/spec/models/in_person_signer_spec.rb +0 -365
  352. data/spec/models/initial_here_spec.rb +0 -197
  353. data/spec/models/inline_template_spec.rb +0 -65
  354. data/spec/models/integrated_user_info_list_spec.rb +0 -83
  355. data/spec/models/intermediary_spec.rb +0 -287
  356. data/spec/models/last_name_spec.rb +0 -221
  357. data/spec/models/list_custom_field_spec.rb +0 -83
  358. data/spec/models/list_item_spec.rb +0 -53
  359. data/spec/models/list_spec.rb +0 -269
  360. data/spec/models/lock_information_spec.rb +0 -83
  361. data/spec/models/lock_request_spec.rb +0 -65
  362. data/spec/models/login_account_spec.rb +0 -101
  363. data/spec/models/login_information_spec.rb +0 -47
  364. data/spec/models/match_box_spec.rb +0 -65
  365. data/spec/models/member_group_shared_item_spec.rb +0 -53
  366. data/spec/models/member_shared_items_spec.rb +0 -59
  367. data/spec/models/merge_field_spec.rb +0 -65
  368. data/spec/models/mobile_notifier_configuration_information_spec.rb +0 -41
  369. data/spec/models/mobile_notifier_configuration_spec.rb +0 -53
  370. data/spec/models/money_spec.rb +0 -53
  371. data/spec/models/name_value_spec.rb +0 -59
  372. data/spec/models/new_account_definition_spec.rb +0 -95
  373. data/spec/models/new_account_summary_spec.rb +0 -77
  374. data/spec/models/new_user_spec.rb +0 -95
  375. data/spec/models/new_users_definition_spec.rb +0 -41
  376. data/spec/models/new_users_summary_spec.rb +0 -41
  377. data/spec/models/notary_host_spec.rb +0 -275
  378. data/spec/models/note_spec.rb +0 -245
  379. data/spec/models/notification_spec.rb +0 -53
  380. data/spec/models/number_spec.rb +0 -317
  381. data/spec/models/oauth_access_spec.rb +0 -71
  382. data/spec/models/offline_attributes_spec.rb +0 -71
  383. data/spec/models/page_images_spec.rb +0 -77
  384. data/spec/models/page_request_spec.rb +0 -47
  385. data/spec/models/page_spec.rb +0 -83
  386. data/spec/models/payment_details_spec.rb +0 -65
  387. data/spec/models/payment_line_item_spec.rb +0 -59
  388. data/spec/models/permission_profile_information_spec.rb +0 -41
  389. data/spec/models/permission_profile_spec.rb +0 -77
  390. data/spec/models/plan_information_spec.rb +0 -71
  391. data/spec/models/post_transactions_request_spec.rb +0 -59
  392. data/spec/models/post_transactions_response_spec.rb +0 -47
  393. data/spec/models/power_form_form_data_envelope_spec.rb +0 -47
  394. data/spec/models/power_form_form_data_recipient_spec.rb +0 -59
  395. data/spec/models/power_form_recipient_spec.rb +0 -113
  396. data/spec/models/power_form_senders_response_spec.rb +0 -77
  397. data/spec/models/power_form_spec.rb +0 -179
  398. data/spec/models/power_forms_form_data_response_spec.rb +0 -41
  399. data/spec/models/power_forms_request_spec.rb +0 -41
  400. data/spec/models/power_forms_response_spec.rb +0 -77
  401. data/spec/models/property_metadata_spec.rb +0 -47
  402. data/spec/models/province_spec.rb +0 -47
  403. data/spec/models/provisioning_information_spec.rb +0 -77
  404. data/spec/models/purchased_envelopes_information_spec.rb +0 -89
  405. data/spec/models/radio_group_spec.rb +0 -89
  406. data/spec/models/radio_spec.rb +0 -143
  407. data/spec/models/recipient_attachment_spec.rb +0 -71
  408. data/spec/models/recipient_domain_spec.rb +0 -59
  409. data/spec/models/recipient_email_notification_spec.rb +0 -53
  410. data/spec/models/recipient_event_spec.rb +0 -47
  411. data/spec/models/recipient_form_data_spec.rb +0 -83
  412. data/spec/models/recipient_names_response_spec.rb +0 -53
  413. data/spec/models/recipient_phone_authentication_spec.rb +0 -59
  414. data/spec/models/recipient_saml_authentication_spec.rb +0 -41
  415. data/spec/models/recipient_signature_information_spec.rb +0 -53
  416. data/spec/models/recipient_signature_provider_options_spec.rb +0 -59
  417. data/spec/models/recipient_signature_provider_spec.rb +0 -47
  418. data/spec/models/recipient_sms_authentication_spec.rb +0 -41
  419. data/spec/models/recipient_update_response_spec.rb +0 -53
  420. data/spec/models/recipient_view_request_spec.rb +0 -119
  421. data/spec/models/recipients_spec.rb +0 -95
  422. data/spec/models/recipients_update_summary_spec.rb +0 -41
  423. data/spec/models/referral_information_spec.rb +0 -143
  424. data/spec/models/reminders_spec.rb +0 -53
  425. data/spec/models/resource_information_spec.rb +0 -41
  426. data/spec/models/return_url_request_spec.rb +0 -41
  427. data/spec/models/saml_assertion_attribute_spec.rb +0 -59
  428. data/spec/models/seat_discount_spec.rb +0 -53
  429. data/spec/models/sender_email_notifications_spec.rb +0 -77
  430. data/spec/models/server_template_spec.rb +0 -47
  431. data/spec/models/service_information_spec.rb +0 -71
  432. data/spec/models/service_version_spec.rb +0 -47
  433. data/spec/models/settings_metadata_spec.rb +0 -71
  434. data/spec/models/shared_item_spec.rb +0 -53
  435. data/spec/models/sign_here_spec.rb +0 -197
  436. data/spec/models/signature_provider_required_option_spec.rb +0 -47
  437. data/spec/models/signature_type_spec.rb +0 -47
  438. data/spec/models/signer_attachment_spec.rb +0 -197
  439. data/spec/models/signer_email_notifications_spec.rb +0 -119
  440. data/spec/models/signer_spec.rb +0 -371
  441. data/spec/models/signing_group_information_spec.rb +0 -41
  442. data/spec/models/signing_group_spec.rb +0 -95
  443. data/spec/models/signing_group_user_spec.rb +0 -53
  444. data/spec/models/signing_group_users_spec.rb +0 -41
  445. data/spec/models/social_account_information_spec.rb +0 -65
  446. data/spec/models/social_authentication_spec.rb +0 -41
  447. data/spec/models/ssn4_information_input_spec.rb +0 -53
  448. data/spec/models/ssn9_information_input_spec.rb +0 -47
  449. data/spec/models/ssn_spec.rb +0 -305
  450. data/spec/models/tab_account_settings_spec.rb +0 -263
  451. data/spec/models/tab_metadata_list_spec.rb +0 -41
  452. data/spec/models/tab_metadata_spec.rb +0 -269
  453. data/spec/models/tabs_spec.rb +0 -185
  454. data/spec/models/template_custom_fields_spec.rb +0 -47
  455. data/spec/models/template_document_visibility_list_spec.rb +0 -41
  456. data/spec/models/template_documents_result_spec.rb +0 -47
  457. data/spec/models/template_information_spec.rb +0 -41
  458. data/spec/models/template_match_spec.rb +0 -53
  459. data/spec/models/template_notification_request_spec.rb +0 -59
  460. data/spec/models/template_recipients_spec.rb +0 -95
  461. data/spec/models/template_role_spec.rb +0 -107
  462. data/spec/models/template_shared_item_spec.rb +0 -77
  463. data/spec/models/template_summary_spec.rb +0 -77
  464. data/spec/models/template_tabs_spec.rb +0 -185
  465. data/spec/models/template_update_summary_spec.rb +0 -83
  466. data/spec/models/text_custom_field_spec.rb +0 -77
  467. data/spec/models/text_spec.rb +0 -323
  468. data/spec/models/title_spec.rb +0 -269
  469. data/spec/models/usage_history_spec.rb +0 -59
  470. data/spec/models/user_account_management_granular_information_spec.rb +0 -83
  471. data/spec/models/user_info_list_spec.rb +0 -41
  472. data/spec/models/user_info_spec.rb +0 -95
  473. data/spec/models/user_information_list_spec.rb +0 -77
  474. data/spec/models/user_information_spec.rb +0 -239
  475. data/spec/models/user_password_information_spec.rb +0 -59
  476. data/spec/models/user_profile_spec.rb +0 -107
  477. data/spec/models/user_settings_information_spec.rb +0 -59
  478. data/spec/models/user_shared_item_spec.rb +0 -53
  479. data/spec/models/user_signature_definition_spec.rb +0 -59
  480. data/spec/models/user_signature_spec.rb +0 -113
  481. data/spec/models/user_signatures_information_spec.rb +0 -41
  482. data/spec/models/user_social_id_result_spec.rb +0 -47
  483. data/spec/models/users_response_spec.rb +0 -77
  484. data/spec/models/view_link_request_spec.rb +0 -47
  485. data/spec/models/view_spec.rb +0 -245
  486. data/spec/models/view_url_spec.rb +0 -41
  487. data/spec/models/workspace_folder_contents_spec.rb +0 -83
  488. data/spec/models/workspace_item_list_spec.rb +0 -41
  489. data/spec/models/workspace_item_spec.rb +0 -149
  490. data/spec/models/workspace_list_spec.rb +0 -65
  491. data/spec/models/workspace_spec.rb +0 -101
  492. data/spec/models/workspace_user_authorization_spec.rb +0 -101
  493. data/spec/models/workspace_user_spec.rb +0 -131
  494. data/spec/models/zip_spec.rb +0 -311
  495. data/spec/spec_helper.rb +0 -110
  496. data/tests/keys/docusign_private_key.txt.enc +0 -0
@@ -1,649 +0,0 @@
1
- =begin
2
- #DocuSign REST API
3
-
4
- #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
-
6
- OpenAPI spec version: v2
7
- Contact: devcenter@docusign.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
-
10
- =end
11
-
12
- require 'spec_helper'
13
- require 'json'
14
-
15
- # Unit tests for SwaggerClient::TemplatesApi
16
- # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
17
- # Please update as you see appropriate
18
- describe 'TemplatesApi' do
19
- before do
20
- # run before each test
21
- @instance = SwaggerClient::TemplatesApi.new
22
- end
23
-
24
- after do
25
- # run after each test
26
- end
27
-
28
- describe 'test an instance of TemplatesApi' do
29
- it 'should create an instact of TemplatesApi' do
30
- expect(@instance).to be_instance_of(SwaggerClient::TemplatesApi)
31
- end
32
- end
33
-
34
- # unit tests for create_custom_fields
35
- # Creates custom document fields in an existing template document.
36
- # Creates custom document fields in an existing template document.
37
- # @param account_id The external account number (int) or account ID Guid.
38
- # @param template_id The ID of the template being accessed.
39
- # @param [Hash] opts the optional parameters
40
- # @option opts [TemplateCustomFields] :template_custom_fields
41
- # @return [CustomFields]
42
- describe 'create_custom_fields test' do
43
- it "should work" do
44
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
45
- end
46
- end
47
-
48
- # unit tests for create_document_fields
49
- # Creates custom document fields in an existing template document.
50
- # Creates custom document fields in an existing template document.
51
- # @param account_id The external account number (int) or account ID Guid.
52
- # @param document_id The ID of the document being accessed.
53
- # @param template_id The ID of the template being accessed.
54
- # @param [Hash] opts the optional parameters
55
- # @option opts [DocumentFieldsInformation] :document_fields_information
56
- # @return [DocumentFieldsInformation]
57
- describe 'create_document_fields test' do
58
- it "should work" do
59
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
60
- end
61
- end
62
-
63
- # unit tests for create_edit_view
64
- # Provides a URL to start an edit view of the Template UI
65
- #
66
- # @param account_id The external account number (int) or account ID Guid.
67
- # @param template_id The ID of the template being accessed.
68
- # @param [Hash] opts the optional parameters
69
- # @option opts [ReturnUrlRequest] :return_url_request
70
- # @return [ViewUrl]
71
- describe 'create_edit_view test' do
72
- it "should work" do
73
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
74
- end
75
- end
76
-
77
- # unit tests for create_lock
78
- # Lock a template.
79
- # Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to **true** for the user).
80
- # @param account_id The external account number (int) or account ID Guid.
81
- # @param template_id The ID of the template being accessed.
82
- # @param [Hash] opts the optional parameters
83
- # @option opts [LockRequest] :lock_request
84
- # @return [LockInformation]
85
- describe 'create_lock test' do
86
- it "should work" do
87
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
88
- end
89
- end
90
-
91
- # unit tests for create_recipients
92
- # Adds tabs for a recipient.
93
- # Adds one or more recipients to a template.
94
- # @param account_id The external account number (int) or account ID Guid.
95
- # @param template_id The ID of the template being accessed.
96
- # @param [Hash] opts the optional parameters
97
- # @option opts [String] :resend_envelope
98
- # @option opts [TemplateRecipients] :template_recipients
99
- # @return [Recipients]
100
- describe 'create_recipients test' do
101
- it "should work" do
102
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
103
- end
104
- end
105
-
106
- # unit tests for create_tabs
107
- # Adds tabs for a recipient.
108
- # Adds one or more tabs for a recipient.
109
- # @param account_id The external account number (int) or account ID Guid.
110
- # @param recipient_id The ID of the recipient being accessed.
111
- # @param template_id The ID of the template being accessed.
112
- # @param [Hash] opts the optional parameters
113
- # @option opts [TemplateTabs] :template_tabs
114
- # @return [Tabs]
115
- describe 'create_tabs test' do
116
- it "should work" do
117
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
118
- end
119
- end
120
-
121
- # unit tests for create_template
122
- # Creates an envelope from a template.
123
- # Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient’s role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient’s name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",` To add a recipient’s email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.
124
- # @param account_id The external account number (int) or account ID Guid.
125
- # @param [Hash] opts the optional parameters
126
- # @option opts [EnvelopeTemplate] :envelope_template
127
- # @return [TemplateSummary]
128
- describe 'create_template test' do
129
- it "should work" do
130
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
131
- end
132
- end
133
-
134
- # unit tests for delete_bulk_recipients
135
- # Deletes the bulk recipient list on a template.
136
- # Deletes the bulk recipient list on a template.
137
- # @param account_id The external account number (int) or account ID Guid.
138
- # @param recipient_id The ID of the recipient being accessed.
139
- # @param template_id The ID of the template being accessed.
140
- # @param [Hash] opts the optional parameters
141
- # @return [BulkRecipientsUpdateResponse]
142
- describe 'delete_bulk_recipients test' do
143
- it "should work" do
144
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
145
- end
146
- end
147
-
148
- # unit tests for delete_custom_fields
149
- # Deletes envelope custom fields in a template.
150
- # Deletes envelope custom fields in a template.
151
- # @param account_id The external account number (int) or account ID Guid.
152
- # @param template_id The ID of the template being accessed.
153
- # @param [Hash] opts the optional parameters
154
- # @option opts [TemplateCustomFields] :template_custom_fields
155
- # @return [CustomFields]
156
- describe 'delete_custom_fields test' do
157
- it "should work" do
158
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
159
- end
160
- end
161
-
162
- # unit tests for delete_document_fields
163
- # Deletes custom document fields from an existing template document.
164
- # Deletes custom document fields from an existing template document.
165
- # @param account_id The external account number (int) or account ID Guid.
166
- # @param document_id The ID of the document being accessed.
167
- # @param template_id The ID of the template being accessed.
168
- # @param [Hash] opts the optional parameters
169
- # @option opts [DocumentFieldsInformation] :document_fields_information
170
- # @return [DocumentFieldsInformation]
171
- describe 'delete_document_fields test' do
172
- it "should work" do
173
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
174
- end
175
- end
176
-
177
- # unit tests for delete_document_page
178
- # Deletes a page from a document in an template.
179
- # Deletes a page from a document in a template based on the page number.
180
- # @param account_id The external account number (int) or account ID Guid.
181
- # @param document_id The ID of the document being accessed.
182
- # @param page_number The page number being accessed.
183
- # @param template_id The ID of the template being accessed.
184
- # @param [Hash] opts the optional parameters
185
- # @option opts [PageRequest] :page_request
186
- # @return [nil]
187
- describe 'delete_document_page test' do
188
- it "should work" do
189
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
190
- end
191
- end
192
-
193
- # unit tests for delete_documents
194
- # Deletes documents from a template.
195
- # Deletes one or more documents from an existing template.
196
- # @param account_id The external account number (int) or account ID Guid.
197
- # @param template_id The ID of the template being accessed.
198
- # @param [Hash] opts the optional parameters
199
- # @option opts [EnvelopeDefinition] :envelope_definition
200
- # @return [TemplateDocumentsResult]
201
- describe 'delete_documents test' do
202
- it "should work" do
203
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
204
- end
205
- end
206
-
207
- # unit tests for delete_group_share
208
- # Removes a member group's sharing permissions for a template.
209
- # Removes a member group's sharing permissions for a specified template.
210
- # @param account_id The external account number (int) or account ID Guid.
211
- # @param template_id The ID of the template being accessed.
212
- # @param template_part Currently, the only defined part is **groups**.
213
- # @param [Hash] opts the optional parameters
214
- # @option opts [GroupInformation] :group_information
215
- # @return [GroupInformation]
216
- describe 'delete_group_share test' do
217
- it "should work" do
218
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
219
- end
220
- end
221
-
222
- # unit tests for delete_lock
223
- # Deletes a template lock.
224
- # Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
225
- # @param account_id The external account number (int) or account ID Guid.
226
- # @param template_id The ID of the template being accessed.
227
- # @param [Hash] opts the optional parameters
228
- # @option opts [LockRequest] :lock_request
229
- # @return [LockInformation]
230
- describe 'delete_lock test' do
231
- it "should work" do
232
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
233
- end
234
- end
235
-
236
- # unit tests for delete_recipient
237
- # Deletes the specified recipient file from a template.
238
- # Deletes the specified recipient file from the specified template.
239
- # @param account_id The external account number (int) or account ID Guid.
240
- # @param recipient_id The ID of the recipient being accessed.
241
- # @param template_id The ID of the template being accessed.
242
- # @param [Hash] opts the optional parameters
243
- # @option opts [TemplateRecipients] :template_recipients
244
- # @return [Recipients]
245
- describe 'delete_recipient test' do
246
- it "should work" do
247
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
248
- end
249
- end
250
-
251
- # unit tests for delete_recipients
252
- # Deletes recipients from a template.
253
- # Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.
254
- # @param account_id The external account number (int) or account ID Guid.
255
- # @param template_id The ID of the template being accessed.
256
- # @param [Hash] opts the optional parameters
257
- # @option opts [TemplateRecipients] :template_recipients
258
- # @return [Recipients]
259
- describe 'delete_recipients test' do
260
- it "should work" do
261
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
262
- end
263
- end
264
-
265
- # unit tests for delete_tabs
266
- # Deletes the tabs associated with a recipient in a template.
267
- # Deletes one or more tabs associated with a recipient in a template.
268
- # @param account_id The external account number (int) or account ID Guid.
269
- # @param recipient_id The ID of the recipient being accessed.
270
- # @param template_id The ID of the template being accessed.
271
- # @param [Hash] opts the optional parameters
272
- # @option opts [TemplateTabs] :template_tabs
273
- # @return [Tabs]
274
- describe 'delete_tabs test' do
275
- it "should work" do
276
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
277
- end
278
- end
279
-
280
- # unit tests for get
281
- # Gets a list of templates for a specified account.
282
- # Retrieves the definition of the specified template.
283
- # @param account_id The external account number (int) or account ID Guid.
284
- # @param template_id The ID of the template being accessed.
285
- # @param [Hash] opts the optional parameters
286
- # @option opts [String] :include
287
- # @return [EnvelopeTemplate]
288
- describe 'get test' do
289
- it "should work" do
290
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
291
- end
292
- end
293
-
294
- # unit tests for get_document
295
- # Gets PDF documents from a template.
296
- # Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.
297
- # @param account_id The external account number (int) or account ID Guid.
298
- # @param document_id The ID of the document being accessed.
299
- # @param template_id The ID of the template being accessed.
300
- # @param [Hash] opts the optional parameters
301
- # @option opts [String] :encrypt
302
- # @option opts [String] :show_changes
303
- # @return [File]
304
- describe 'get_document test' do
305
- it "should work" do
306
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
307
- end
308
- end
309
-
310
- # unit tests for get_document_page_image
311
- # Gets a page image from a template for display.
312
- # Retrieves a page image for display from the specified template.
313
- # @param account_id The external account number (int) or account ID Guid.
314
- # @param document_id The ID of the document being accessed.
315
- # @param page_number The page number being accessed.
316
- # @param template_id The ID of the template being accessed.
317
- # @param [Hash] opts the optional parameters
318
- # @option opts [String] :dpi
319
- # @option opts [String] :max_height
320
- # @option opts [String] :max_width
321
- # @option opts [String] :show_changes
322
- # @return [File]
323
- describe 'get_document_page_image test' do
324
- it "should work" do
325
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
326
- end
327
- end
328
-
329
- # unit tests for get_lock
330
- # Gets template lock information.
331
- # Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
332
- # @param account_id The external account number (int) or account ID Guid.
333
- # @param template_id The ID of the template being accessed.
334
- # @param [Hash] opts the optional parameters
335
- # @return [LockInformation]
336
- describe 'get_lock test' do
337
- it "should work" do
338
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
339
- end
340
- end
341
-
342
- # unit tests for get_notification_settings
343
- # Gets template notification information.
344
- # Retrieves the envelope notification, reminders and expirations, information for an existing template.
345
- # @param account_id The external account number (int) or account ID Guid.
346
- # @param template_id The ID of the template being accessed.
347
- # @param [Hash] opts the optional parameters
348
- # @return [Notification]
349
- describe 'get_notification_settings test' do
350
- it "should work" do
351
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
352
- end
353
- end
354
-
355
- # unit tests for list_bulk_recipients
356
- # Gets the bulk recipient file from a template.
357
- # Retrieves the bulk recipient file information from a template that has a bulk recipient.
358
- # @param account_id The external account number (int) or account ID Guid.
359
- # @param recipient_id The ID of the recipient being accessed.
360
- # @param template_id The ID of the template being accessed.
361
- # @param [Hash] opts the optional parameters
362
- # @option opts [String] :include_tabs
363
- # @option opts [String] :start_position
364
- # @return [BulkRecipientsResponse]
365
- describe 'list_bulk_recipients test' do
366
- it "should work" do
367
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
368
- end
369
- end
370
-
371
- # unit tests for list_custom_fields
372
- # Gets the custom document fields from a template.
373
- # Retrieves the custom document field information from an existing template.
374
- # @param account_id The external account number (int) or account ID Guid.
375
- # @param template_id The ID of the template being accessed.
376
- # @param [Hash] opts the optional parameters
377
- # @return [CustomFields]
378
- describe 'list_custom_fields test' do
379
- it "should work" do
380
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
381
- end
382
- end
383
-
384
- # unit tests for list_document_fields
385
- # Gets the custom document fields for a an existing template document.
386
- # Retrieves the custom document fields for an existing template document.
387
- # @param account_id The external account number (int) or account ID Guid.
388
- # @param document_id The ID of the document being accessed.
389
- # @param template_id The ID of the template being accessed.
390
- # @param [Hash] opts the optional parameters
391
- # @return [DocumentFieldsInformation]
392
- describe 'list_document_fields test' do
393
- it "should work" do
394
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
395
- end
396
- end
397
-
398
- # unit tests for list_documents
399
- # Gets a list of documents associated with a template.
400
- # Retrieves a list of documents associated with the specified template.
401
- # @param account_id The external account number (int) or account ID Guid.
402
- # @param template_id The ID of the template being accessed.
403
- # @param [Hash] opts the optional parameters
404
- # @return [TemplateDocumentsResult]
405
- describe 'list_documents test' do
406
- it "should work" do
407
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
408
- end
409
- end
410
-
411
- # unit tests for list_recipients
412
- # Gets recipient information from a template.
413
- # Retrieves the information for all recipients in the specified template.
414
- # @param account_id The external account number (int) or account ID Guid.
415
- # @param template_id The ID of the template being accessed.
416
- # @param [Hash] opts the optional parameters
417
- # @option opts [String] :include_anchor_tab_locations When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response.
418
- # @option opts [String] :include_extended When set to **true**, the extended properties are included in the response.
419
- # @option opts [String] :include_tabs When set to **true**, the tab information associated with the recipient is included in the response.
420
- # @return [Recipients]
421
- describe 'list_recipients test' do
422
- it "should work" do
423
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
424
- end
425
- end
426
-
427
- # unit tests for list_tabs
428
- # Gets the tabs information for a signer or sign-in-person recipient in a template.
429
- # Gets the tabs information for a signer or sign-in-person recipient in a template.
430
- # @param account_id The external account number (int) or account ID Guid.
431
- # @param recipient_id The ID of the recipient being accessed.
432
- # @param template_id The ID of the template being accessed.
433
- # @param [Hash] opts the optional parameters
434
- # @option opts [String] :include_anchor_tab_locations When set to **true**, all tabs with anchor tab properties are included in the response.
435
- # @option opts [String] :include_metadata
436
- # @return [Tabs]
437
- describe 'list_tabs test' do
438
- it "should work" do
439
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
440
- end
441
- end
442
-
443
- # unit tests for list_templates
444
- # Gets the definition of a template.
445
- # Retrieves the list of templates for the specified account. The request can be limited to a specific folder.
446
- # @param account_id The external account number (int) or account ID Guid.
447
- # @param [Hash] opts the optional parameters
448
- # @option opts [String] :count Number of records to return in the cache.
449
- # @option opts [String] :folder The query value can be a folder name or folder ID. The response will only return templates in the specified folder.
450
- # @option opts [String] :folder_ids A comma separated list of folder ID GUIDs.
451
- # @option opts [String] :from_date Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
452
- # @option opts [String] :include A comma separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
453
- # @option opts [String] :order Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a)
454
- # @option opts [String] :order_by Sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used.
455
- # @option opts [String] :search_text The search text used to search the names of templates.
456
- # @option opts [String] :shared
457
- # @option opts [String] :shared_by_me If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.
458
- # @option opts [String] :start_position The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).
459
- # @option opts [String] :to_date End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.
460
- # @option opts [String] :used_from_date Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.
461
- # @option opts [String] :used_to_date End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.
462
- # @option opts [String] :user_filter Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user.
463
- # @return [EnvelopeTemplateResults]
464
- describe 'list_templates test' do
465
- it "should work" do
466
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
467
- end
468
- end
469
-
470
- # unit tests for rotate_document_page
471
- # Rotates page image from a template for display.
472
- # Rotates page image from a template for display. The page image can be rotated to the left or right.
473
- # @param account_id The external account number (int) or account ID Guid.
474
- # @param document_id The ID of the document being accessed.
475
- # @param page_number The page number being accessed.
476
- # @param template_id The ID of the template being accessed.
477
- # @param [Hash] opts the optional parameters
478
- # @option opts [PageRequest] :page_request
479
- # @return [nil]
480
- describe 'rotate_document_page test' do
481
- it "should work" do
482
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
483
- end
484
- end
485
-
486
- # unit tests for update
487
- # Updates an existing template.
488
- # Updates an existing template.
489
- # @param account_id The external account number (int) or account ID Guid.
490
- # @param template_id The ID of the template being accessed.
491
- # @param [Hash] opts the optional parameters
492
- # @option opts [EnvelopeTemplate] :envelope_template
493
- # @return [TemplateUpdateSummary]
494
- describe 'update test' do
495
- it "should work" do
496
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
497
- end
498
- end
499
-
500
- # unit tests for update_bulk_recipients
501
- # Adds or replaces the bulk recipients list in a template.
502
- # Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
503
- # @param account_id The external account number (int) or account ID Guid.
504
- # @param recipient_id The ID of the recipient being accessed.
505
- # @param template_id The ID of the template being accessed.
506
- # @param [Hash] opts the optional parameters
507
- # @option opts [BulkRecipientsRequest] :bulk_recipients_request
508
- # @return [BulkRecipientsSummaryResponse]
509
- describe 'update_bulk_recipients test' do
510
- it "should work" do
511
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
512
- end
513
- end
514
-
515
- # unit tests for update_custom_fields
516
- # Updates envelope custom fields in a template.
517
- # Updates the custom fields in a template. Each custom field used in a template must have a unique name.
518
- # @param account_id The external account number (int) or account ID Guid.
519
- # @param template_id The ID of the template being accessed.
520
- # @param [Hash] opts the optional parameters
521
- # @option opts [TemplateCustomFields] :template_custom_fields
522
- # @return [CustomFields]
523
- describe 'update_custom_fields test' do
524
- it "should work" do
525
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
526
- end
527
- end
528
-
529
- # unit tests for update_document
530
- # Adds a document to a template document.
531
- # Adds the specified document to an existing template document.
532
- # @param account_id The external account number (int) or account ID Guid.
533
- # @param document_id The ID of the document being accessed.
534
- # @param template_id The ID of the template being accessed.
535
- # @param [Hash] opts the optional parameters
536
- # @option opts [String] :apply_document_fields
537
- # @option opts [String] :is_envelope_definition
538
- # @option opts [EnvelopeDefinition] :envelope_definition
539
- # @return [EnvelopeDocument]
540
- describe 'update_document test' do
541
- it "should work" do
542
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
543
- end
544
- end
545
-
546
- # unit tests for update_document_fields
547
- # Updates existing custom document fields in an existing template document.
548
- # Updates existing custom document fields in an existing template document.
549
- # @param account_id The external account number (int) or account ID Guid.
550
- # @param document_id The ID of the document being accessed.
551
- # @param template_id The ID of the template being accessed.
552
- # @param [Hash] opts the optional parameters
553
- # @option opts [DocumentFieldsInformation] :document_fields_information
554
- # @return [DocumentFieldsInformation]
555
- describe 'update_document_fields test' do
556
- it "should work" do
557
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
558
- end
559
- end
560
-
561
- # unit tests for update_documents
562
- # Adds documents to a template document.
563
- # Adds one or more documents to an existing template document.
564
- # @param account_id The external account number (int) or account ID Guid.
565
- # @param template_id The ID of the template being accessed.
566
- # @param [Hash] opts the optional parameters
567
- # @option opts [String] :apply_document_fields
568
- # @option opts [EnvelopeDefinition] :envelope_definition
569
- # @return [TemplateDocumentsResult]
570
- describe 'update_documents test' do
571
- it "should work" do
572
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
573
- end
574
- end
575
-
576
- # unit tests for update_group_share
577
- # Shares a template with a group
578
- # Shares a template with the specified members group.
579
- # @param account_id The external account number (int) or account ID Guid.
580
- # @param template_id The ID of the template being accessed.
581
- # @param template_part Currently, the only defined part is **groups**.
582
- # @param [Hash] opts the optional parameters
583
- # @option opts [GroupInformation] :group_information
584
- # @return [GroupInformation]
585
- describe 'update_group_share test' do
586
- it "should work" do
587
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
588
- end
589
- end
590
-
591
- # unit tests for update_lock
592
- # Updates a template lock.
593
- # Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
594
- # @param account_id The external account number (int) or account ID Guid.
595
- # @param template_id The ID of the template being accessed.
596
- # @param [Hash] opts the optional parameters
597
- # @option opts [LockRequest] :lock_request
598
- # @return [LockInformation]
599
- describe 'update_lock test' do
600
- it "should work" do
601
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
602
- end
603
- end
604
-
605
- # unit tests for update_notification_settings
606
- # Updates the notification structure for an existing template.
607
- # Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.
608
- # @param account_id The external account number (int) or account ID Guid.
609
- # @param template_id The ID of the template being accessed.
610
- # @param [Hash] opts the optional parameters
611
- # @option opts [TemplateNotificationRequest] :template_notification_request
612
- # @return [Notification]
613
- describe 'update_notification_settings test' do
614
- it "should work" do
615
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
616
- end
617
- end
618
-
619
- # unit tests for update_recipients
620
- # Updates recipients in a template.
621
- # Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
622
- # @param account_id The external account number (int) or account ID Guid.
623
- # @param template_id The ID of the template being accessed.
624
- # @param [Hash] opts the optional parameters
625
- # @option opts [String] :resend_envelope
626
- # @option opts [TemplateRecipients] :template_recipients
627
- # @return [RecipientsUpdateSummary]
628
- describe 'update_recipients test' do
629
- it "should work" do
630
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
631
- end
632
- end
633
-
634
- # unit tests for update_tabs
635
- # Updates the tabs for a recipient.
636
- # Updates one or more tabs for a recipient in a template.
637
- # @param account_id The external account number (int) or account ID Guid.
638
- # @param recipient_id The ID of the recipient being accessed.
639
- # @param template_id The ID of the template being accessed.
640
- # @param [Hash] opts the optional parameters
641
- # @option opts [TemplateTabs] :template_tabs
642
- # @return [Tabs]
643
- describe 'update_tabs test' do
644
- it "should work" do
645
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
646
- end
647
- end
648
-
649
- end