docusign_esign 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (992) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/LICENSE +21 -0
  4. data/README.md +101 -0
  5. data/Rakefile +8 -0
  6. data/docs/AccountAddress.md +19 -0
  7. data/docs/AccountBillingPlan.md +27 -0
  8. data/docs/AccountBillingPlanResponse.md +13 -0
  9. data/docs/AccountInformation.md +38 -0
  10. data/docs/AccountRoleSettings.md +71 -0
  11. data/docs/AccountSettingsInformation.md +8 -0
  12. data/docs/AccountSharedAccess.md +16 -0
  13. data/docs/AccountSignatureProvider.md +14 -0
  14. data/docs/AccountSignatureProviderOption.md +10 -0
  15. data/docs/AccountSignatureProviders.md +8 -0
  16. data/docs/AccountsApi.md +1997 -0
  17. data/docs/AddOn.md +11 -0
  18. data/docs/AddressInformation.md +15 -0
  19. data/docs/AddressInformationInput.md +10 -0
  20. data/docs/AddressInformationV2.md +15 -0
  21. data/docs/Agent.md +49 -0
  22. data/docs/ApiRequestLog.md +11 -0
  23. data/docs/ApiRequestLogsResult.md +8 -0
  24. data/docs/AppStoreProduct.md +9 -0
  25. data/docs/AppStoreReceipt.md +9 -0
  26. data/docs/Approve.md +40 -0
  27. data/docs/Attachment.md +14 -0
  28. data/docs/AuthenticationApi.md +356 -0
  29. data/docs/AuthenticationMethod.md +11 -0
  30. data/docs/AuthenticationStatus.md +24 -0
  31. data/docs/BccEmailAddress.md +9 -0
  32. data/docs/BillingApi.md +569 -0
  33. data/docs/BillingCharge.md +20 -0
  34. data/docs/BillingChargeResponse.md +8 -0
  35. data/docs/BillingDiscount.md +10 -0
  36. data/docs/BillingInvoice.md +17 -0
  37. data/docs/BillingInvoiceItem.md +12 -0
  38. data/docs/BillingInvoicesResponse.md +10 -0
  39. data/docs/BillingInvoicesSummary.md +10 -0
  40. data/docs/BillingPayment.md +10 -0
  41. data/docs/BillingPaymentItem.md +12 -0
  42. data/docs/BillingPaymentRequest.md +8 -0
  43. data/docs/BillingPaymentResponse.md +8 -0
  44. data/docs/BillingPaymentsResponse.md +10 -0
  45. data/docs/BillingPlan.md +22 -0
  46. data/docs/BillingPlanInformation.md +22 -0
  47. data/docs/BillingPlanPreview.md +13 -0
  48. data/docs/BillingPlanResponse.md +9 -0
  49. data/docs/BillingPlanUpdateResponse.md +14 -0
  50. data/docs/BillingPlansResponse.md +8 -0
  51. data/docs/BillingPrice.md +10 -0
  52. data/docs/Brand.md +20 -0
  53. data/docs/BrandEmailContent.md +11 -0
  54. data/docs/BrandLink.md +11 -0
  55. data/docs/BrandLogos.md +10 -0
  56. data/docs/BrandRequest.md +8 -0
  57. data/docs/BrandResourceUrls.md +11 -0
  58. data/docs/BrandResources.md +14 -0
  59. data/docs/BrandResourcesList.md +8 -0
  60. data/docs/BrandsRequest.md +8 -0
  61. data/docs/BrandsResponse.md +10 -0
  62. data/docs/BulkEnvelope.md +16 -0
  63. data/docs/BulkEnvelopeStatus.md +21 -0
  64. data/docs/BulkEnvelopesApi.md +295 -0
  65. data/docs/BulkEnvelopesResponse.md +14 -0
  66. data/docs/BulkRecipient.md +17 -0
  67. data/docs/BulkRecipientSignatureProvider.md +9 -0
  68. data/docs/BulkRecipientTabLabel.md +9 -0
  69. data/docs/BulkRecipientsRequest.md +8 -0
  70. data/docs/BulkRecipientsResponse.md +14 -0
  71. data/docs/BulkRecipientsSummaryResponse.md +11 -0
  72. data/docs/BulkRecipientsUpdateResponse.md +8 -0
  73. data/docs/CaptiveRecipient.md +11 -0
  74. data/docs/CaptiveRecipientInformation.md +8 -0
  75. data/docs/CarbonCopy.md +49 -0
  76. data/docs/CertifiedDelivery.md +49 -0
  77. data/docs/Checkbox.md +37 -0
  78. data/docs/ChunkedUploadPart.md +9 -0
  79. data/docs/ChunkedUploadRequest.md +9 -0
  80. data/docs/ChunkedUploadResponse.md +14 -0
  81. data/docs/CloudStorageApi.md +424 -0
  82. data/docs/CloudStorageProvider.md +12 -0
  83. data/docs/CloudStorageProviders.md +8 -0
  84. data/docs/Company.md +46 -0
  85. data/docs/CompositeTemplate.md +12 -0
  86. data/docs/ConnectApi.md +891 -0
  87. data/docs/ConnectConfigResults.md +9 -0
  88. data/docs/ConnectCustomConfiguration.md +28 -0
  89. data/docs/ConnectDebugLog.md +12 -0
  90. data/docs/ConnectFailureFilter.md +9 -0
  91. data/docs/ConnectFailureResult.md +12 -0
  92. data/docs/ConnectFailureResults.md +8 -0
  93. data/docs/ConnectLog.md +25 -0
  94. data/docs/ConnectLogs.md +11 -0
  95. data/docs/ConsoleViewRequest.md +9 -0
  96. data/docs/ConsumerDisclosure.md +37 -0
  97. data/docs/Contact.md +16 -0
  98. data/docs/ContactGetResponse.md +14 -0
  99. data/docs/ContactModRequest.md +8 -0
  100. data/docs/ContactUpdateResponse.md +8 -0
  101. data/docs/CorrectViewRequest.md +9 -0
  102. data/docs/Country.md +11 -0
  103. data/docs/CreditCardInformation.md +13 -0
  104. data/docs/CreditCardTypes.md +8 -0
  105. data/docs/CurrencyFeatureSetPrice.md +12 -0
  106. data/docs/CurrencyPlanPrice.md +13 -0
  107. data/docs/CustomFieldV2.md +14 -0
  108. data/docs/CustomFields.md +9 -0
  109. data/docs/CustomFieldsEnvelope.md +9 -0
  110. data/docs/CustomSettingsInformation.md +8 -0
  111. data/docs/CustomTabsApi.md +268 -0
  112. data/docs/Date.md +52 -0
  113. data/docs/DateSigned.md +39 -0
  114. data/docs/Decline.md +41 -0
  115. data/docs/DiagnosticsApi.md +321 -0
  116. data/docs/DiagnosticsSettingsInformation.md +10 -0
  117. data/docs/DobInformationInput.md +10 -0
  118. data/docs/Document.md +27 -0
  119. data/docs/DocumentFieldsInformation.md +8 -0
  120. data/docs/DocumentTemplate.md +12 -0
  121. data/docs/DocumentTemplateList.md +8 -0
  122. data/docs/DocumentVisibility.md +12 -0
  123. data/docs/DocumentVisibilityList.md +8 -0
  124. data/docs/ENoteConfiguration.md +12 -0
  125. data/docs/Editor.md +48 -0
  126. data/docs/Email.md +52 -0
  127. data/docs/EmailAddress.md +38 -0
  128. data/docs/EmailSettings.md +10 -0
  129. data/docs/Envelope.md +54 -0
  130. data/docs/EnvelopeAttachment.md +13 -0
  131. data/docs/EnvelopeAttachmentsRequest.md +8 -0
  132. data/docs/EnvelopeAttachmentsResult.md +8 -0
  133. data/docs/EnvelopeAuditEvent.md +8 -0
  134. data/docs/EnvelopeAuditEventResponse.md +8 -0
  135. data/docs/EnvelopeDefinition.md +63 -0
  136. data/docs/EnvelopeDocument.md +24 -0
  137. data/docs/EnvelopeDocumentsResult.md +9 -0
  138. data/docs/EnvelopeEvent.md +9 -0
  139. data/docs/EnvelopeFormData.md +13 -0
  140. data/docs/EnvelopeId.md +38 -0
  141. data/docs/EnvelopeIdsRequest.md +9 -0
  142. data/docs/EnvelopeNotificationRequest.md +10 -0
  143. data/docs/EnvelopeSummary.md +11 -0
  144. data/docs/EnvelopeTemplate.md +56 -0
  145. data/docs/EnvelopeTemplateDefinition.md +22 -0
  146. data/docs/EnvelopeTemplateResult.md +68 -0
  147. data/docs/EnvelopeTemplateResults.md +15 -0
  148. data/docs/EnvelopeTransactionStatus.md +11 -0
  149. data/docs/EnvelopeUpdateSummary.md +15 -0
  150. data/docs/EnvelopesApi.md +4306 -0
  151. data/docs/EnvelopesInformation.md +15 -0
  152. data/docs/ErrorDetails.md +9 -0
  153. data/docs/EventNotification.md +22 -0
  154. data/docs/EventResult.md +11 -0
  155. data/docs/Expirations.md +10 -0
  156. data/docs/ExternalDocServiceErrorDetails.md +10 -0
  157. data/docs/ExternalFile.md +15 -0
  158. data/docs/ExternalFolder.md +17 -0
  159. data/docs/FeatureSet.md +16 -0
  160. data/docs/FileType.md +9 -0
  161. data/docs/FileTypeList.md +8 -0
  162. data/docs/Filter.md +18 -0
  163. data/docs/FirstName.md +38 -0
  164. data/docs/Folder.md +19 -0
  165. data/docs/FolderItem.md +28 -0
  166. data/docs/FolderItemResponse.md +14 -0
  167. data/docs/FolderItemV2.md +27 -0
  168. data/docs/FolderItemsResponse.md +14 -0
  169. data/docs/FoldersApi.md +261 -0
  170. data/docs/FoldersRequest.md +9 -0
  171. data/docs/FoldersResponse.md +8 -0
  172. data/docs/ForgottenPasswordInformation.md +15 -0
  173. data/docs/FormulaTab.md +56 -0
  174. data/docs/FullName.md +38 -0
  175. data/docs/Group.md +13 -0
  176. data/docs/GroupInformation.md +14 -0
  177. data/docs/GroupsApi.md +552 -0
  178. data/docs/IdCheckInformationInput.md +11 -0
  179. data/docs/InPersonSigner.md +62 -0
  180. data/docs/InitialHere.md +34 -0
  181. data/docs/InlineTemplate.md +12 -0
  182. data/docs/IntegratedUserInfoList.md +15 -0
  183. data/docs/Intermediary.md +49 -0
  184. data/docs/LastName.md +38 -0
  185. data/docs/List.md +46 -0
  186. data/docs/ListCustomField.md +15 -0
  187. data/docs/ListItem.md +10 -0
  188. data/docs/LockInformation.md +15 -0
  189. data/docs/LockRequest.md +12 -0
  190. data/docs/LoginAccount.md +18 -0
  191. data/docs/LoginInformation.md +9 -0
  192. data/docs/MatchBox.md +12 -0
  193. data/docs/MemberGroupSharedItem.md +10 -0
  194. data/docs/MemberSharedItems.md +11 -0
  195. data/docs/MergeField.md +12 -0
  196. data/docs/MobileNotifierConfiguration.md +10 -0
  197. data/docs/MobileNotifierConfigurationInformation.md +8 -0
  198. data/docs/Money.md +10 -0
  199. data/docs/NameValue.md +11 -0
  200. data/docs/NewAccountDefinition.md +17 -0
  201. data/docs/NewAccountSummary.md +14 -0
  202. data/docs/NewUser.md +17 -0
  203. data/docs/NewUsersDefinition.md +8 -0
  204. data/docs/NewUsersSummary.md +8 -0
  205. data/docs/NotaryHost.md +47 -0
  206. data/docs/Note.md +42 -0
  207. data/docs/Notification.md +10 -0
  208. data/docs/Number.md +54 -0
  209. data/docs/OauthAccess.md +13 -0
  210. data/docs/OfflineAttributes.md +13 -0
  211. data/docs/Page.md +15 -0
  212. data/docs/PageImages.md +14 -0
  213. data/docs/PageRequest.md +9 -0
  214. data/docs/PaymentDetails.md +12 -0
  215. data/docs/PaymentLineItem.md +11 -0
  216. data/docs/PermissionProfile.md +14 -0
  217. data/docs/PermissionProfileInformation.md +8 -0
  218. data/docs/PlanInformation.md +13 -0
  219. data/docs/PostTransactionsRequest.md +11 -0
  220. data/docs/PostTransactionsResponse.md +9 -0
  221. data/docs/PowerForm.md +31 -0
  222. data/docs/PowerFormFormDataEnvelope.md +9 -0
  223. data/docs/PowerFormFormDataRecipient.md +11 -0
  224. data/docs/PowerFormRecipient.md +20 -0
  225. data/docs/PowerFormSendersResponse.md +14 -0
  226. data/docs/PowerFormsApi.md +419 -0
  227. data/docs/PowerFormsFormDataResponse.md +8 -0
  228. data/docs/PowerFormsRequest.md +8 -0
  229. data/docs/PowerFormsResponse.md +14 -0
  230. data/docs/PropertyMetadata.md +9 -0
  231. data/docs/Province.md +9 -0
  232. data/docs/ProvisioningInformation.md +14 -0
  233. data/docs/PurchasedEnvelopesInformation.md +16 -0
  234. data/docs/Radio.md +25 -0
  235. data/docs/RadioGroup.md +16 -0
  236. data/docs/RecipientAttachment.md +13 -0
  237. data/docs/RecipientDomain.md +11 -0
  238. data/docs/RecipientEmailNotification.md +10 -0
  239. data/docs/RecipientEvent.md +9 -0
  240. data/docs/RecipientFormData.md +15 -0
  241. data/docs/RecipientNamesResponse.md +10 -0
  242. data/docs/RecipientPhoneAuthentication.md +11 -0
  243. data/docs/RecipientSAMLAuthentication.md +8 -0
  244. data/docs/RecipientSMSAuthentication.md +8 -0
  245. data/docs/RecipientSignatureInformation.md +10 -0
  246. data/docs/RecipientSignatureProvider.md +9 -0
  247. data/docs/RecipientSignatureProviderOptions.md +11 -0
  248. data/docs/RecipientUpdateResponse.md +10 -0
  249. data/docs/RecipientViewRequest.md +21 -0
  250. data/docs/Recipients.md +17 -0
  251. data/docs/RecipientsUpdateSummary.md +8 -0
  252. data/docs/ReferralInformation.md +25 -0
  253. data/docs/Reminders.md +10 -0
  254. data/docs/ResourceInformation.md +8 -0
  255. data/docs/ReturnUrlRequest.md +8 -0
  256. data/docs/SamlAssertionAttribute.md +11 -0
  257. data/docs/SeatDiscount.md +10 -0
  258. data/docs/SenderEmailNotifications.md +14 -0
  259. data/docs/ServerTemplate.md +9 -0
  260. data/docs/ServiceInformation.md +13 -0
  261. data/docs/ServiceVersion.md +9 -0
  262. data/docs/SettingsMetadata.md +13 -0
  263. data/docs/SharedItem.md +10 -0
  264. data/docs/SignHere.md +34 -0
  265. data/docs/SignatureProviderRequiredOption.md +9 -0
  266. data/docs/SignatureType.md +9 -0
  267. data/docs/Signer.md +63 -0
  268. data/docs/SignerAttachment.md +34 -0
  269. data/docs/SignerEmailNotifications.md +21 -0
  270. data/docs/SigningGroup.md +17 -0
  271. data/docs/SigningGroupInformation.md +8 -0
  272. data/docs/SigningGroupUser.md +10 -0
  273. data/docs/SigningGroupUsers.md +8 -0
  274. data/docs/SigningGroupsApi.md +485 -0
  275. data/docs/SocialAccountInformation.md +12 -0
  276. data/docs/SocialAuthentication.md +8 -0
  277. data/docs/Ssn.md +52 -0
  278. data/docs/Ssn4InformationInput.md +10 -0
  279. data/docs/Ssn9InformationInput.md +9 -0
  280. data/docs/TabAccountSettings.md +45 -0
  281. data/docs/TabMetadata.md +46 -0
  282. data/docs/TabMetadataList.md +8 -0
  283. data/docs/Tabs.md +32 -0
  284. data/docs/TemplateCustomFields.md +9 -0
  285. data/docs/TemplateDocumentVisibilityList.md +8 -0
  286. data/docs/TemplateDocumentsResult.md +9 -0
  287. data/docs/TemplateInformation.md +8 -0
  288. data/docs/TemplateMatch.md +10 -0
  289. data/docs/TemplateNotificationRequest.md +11 -0
  290. data/docs/TemplateRecipients.md +17 -0
  291. data/docs/TemplateRole.md +19 -0
  292. data/docs/TemplateSharedItem.md +14 -0
  293. data/docs/TemplateSummary.md +14 -0
  294. data/docs/TemplateTabs.md +32 -0
  295. data/docs/TemplateUpdateSummary.md +15 -0
  296. data/docs/TemplatesApi.md +2349 -0
  297. data/docs/Text.md +55 -0
  298. data/docs/TextCustomField.md +14 -0
  299. data/docs/Title.md +46 -0
  300. data/docs/UsageHistory.md +11 -0
  301. data/docs/UserAccountManagementGranularInformation.md +15 -0
  302. data/docs/UserInfo.md +17 -0
  303. data/docs/UserInfoList.md +8 -0
  304. data/docs/UserInformation.md +41 -0
  305. data/docs/UserInformationList.md +14 -0
  306. data/docs/UserPasswordInformation.md +11 -0
  307. data/docs/UserProfile.md +19 -0
  308. data/docs/UserSettingsInformation.md +11 -0
  309. data/docs/UserSharedItem.md +10 -0
  310. data/docs/UserSignature.md +20 -0
  311. data/docs/UserSignatureDefinition.md +11 -0
  312. data/docs/UserSignaturesInformation.md +8 -0
  313. data/docs/UserSocialIdResult.md +9 -0
  314. data/docs/UsersApi.md +1566 -0
  315. data/docs/UsersResponse.md +14 -0
  316. data/docs/View.md +42 -0
  317. data/docs/ViewLinkRequest.md +9 -0
  318. data/docs/ViewUrl.md +8 -0
  319. data/docs/Workspace.md +18 -0
  320. data/docs/WorkspaceFolderContents.md +15 -0
  321. data/docs/WorkspaceItem.md +26 -0
  322. data/docs/WorkspaceItemList.md +8 -0
  323. data/docs/WorkspaceList.md +12 -0
  324. data/docs/WorkspaceUser.md +23 -0
  325. data/docs/WorkspaceUserAuthorization.md +18 -0
  326. data/docs/WorkspacesApi.md +630 -0
  327. data/docs/Zip.md +53 -0
  328. data/docusign_esign-1.0.0.gem +0 -0
  329. data/docusign_esign.gemspec +47 -0
  330. data/git_push.sh +55 -0
  331. data/lib/docusign_esign/.DS_Store +0 -0
  332. data/lib/docusign_esign/api/accounts_api.rb +2230 -0
  333. data/lib/docusign_esign/api/authentication_api.rb +393 -0
  334. data/lib/docusign_esign/api/billing_api.rb +636 -0
  335. data/lib/docusign_esign/api/bulk_envelopes_api.rb +355 -0
  336. data/lib/docusign_esign/api/cloud_storage_api.rb +507 -0
  337. data/lib/docusign_esign/api/connect_api.rb +967 -0
  338. data/lib/docusign_esign/api/custom_tabs_api.rb +296 -0
  339. data/lib/docusign_esign/api/diagnostics_api.rb +356 -0
  340. data/lib/docusign_esign/api/envelopes_api.rb +4737 -0
  341. data/lib/docusign_esign/api/folders_api.rb +342 -0
  342. data/lib/docusign_esign/api/groups_api.rb +596 -0
  343. data/lib/docusign_esign/api/power_forms_api.rb +489 -0
  344. data/lib/docusign_esign/api/signing_groups_api.rb +513 -0
  345. data/lib/docusign_esign/api/templates_api.rb +2555 -0
  346. data/lib/docusign_esign/api/users_api.rb +1694 -0
  347. data/lib/docusign_esign/api/workspaces_api.rb +719 -0
  348. data/lib/docusign_esign/api_client.rb +421 -0
  349. data/lib/docusign_esign/api_error.rb +37 -0
  350. data/lib/docusign_esign/configuration.rb +195 -0
  351. data/lib/docusign_esign/models/account_address.rb +300 -0
  352. data/lib/docusign_esign/models/account_billing_plan.rb +384 -0
  353. data/lib/docusign_esign/models/account_billing_plan_response.rb +236 -0
  354. data/lib/docusign_esign/models/account_information.rb +488 -0
  355. data/lib/docusign_esign/models/account_role_settings.rb +786 -0
  356. data/lib/docusign_esign/models/account_settings_information.rb +190 -0
  357. data/lib/docusign_esign/models/account_shared_access.rb +269 -0
  358. data/lib/docusign_esign/models/account_signature_provider.rb +252 -0
  359. data/lib/docusign_esign/models/account_signature_provider_option.rb +208 -0
  360. data/lib/docusign_esign/models/account_signature_providers.rb +190 -0
  361. data/lib/docusign_esign/models/add_on.rb +218 -0
  362. data/lib/docusign_esign/models/address_information.rb +258 -0
  363. data/lib/docusign_esign/models/address_information_input.rb +207 -0
  364. data/lib/docusign_esign/models/address_information_v2.rb +258 -0
  365. data/lib/docusign_esign/models/agent.rb +603 -0
  366. data/lib/docusign_esign/models/api_request_log.rb +218 -0
  367. data/lib/docusign_esign/models/api_request_logs_result.rb +190 -0
  368. data/lib/docusign_esign/models/app_store_product.rb +198 -0
  369. data/lib/docusign_esign/models/app_store_receipt.rb +198 -0
  370. data/lib/docusign_esign/models/approve.rb +506 -0
  371. data/lib/docusign_esign/models/attachment.rb +248 -0
  372. data/lib/docusign_esign/models/authentication_method.rb +218 -0
  373. data/lib/docusign_esign/models/authentication_status.rb +331 -0
  374. data/lib/docusign_esign/models/bcc_email_address.rb +198 -0
  375. data/lib/docusign_esign/models/billing_charge.rb +312 -0
  376. data/lib/docusign_esign/models/billing_charge_response.rb +190 -0
  377. data/lib/docusign_esign/models/billing_discount.rb +208 -0
  378. data/lib/docusign_esign/models/billing_invoice.rb +280 -0
  379. data/lib/docusign_esign/models/billing_invoice_item.rb +228 -0
  380. data/lib/docusign_esign/models/billing_invoices_response.rb +210 -0
  381. data/lib/docusign_esign/models/billing_invoices_summary.rb +210 -0
  382. data/lib/docusign_esign/models/billing_payment.rb +208 -0
  383. data/lib/docusign_esign/models/billing_payment_item.rb +228 -0
  384. data/lib/docusign_esign/models/billing_payment_request.rb +188 -0
  385. data/lib/docusign_esign/models/billing_payment_response.rb +190 -0
  386. data/lib/docusign_esign/models/billing_payments_response.rb +210 -0
  387. data/lib/docusign_esign/models/billing_plan.rb +336 -0
  388. data/lib/docusign_esign/models/billing_plan_information.rb +323 -0
  389. data/lib/docusign_esign/models/billing_plan_preview.rb +237 -0
  390. data/lib/docusign_esign/models/billing_plan_response.rb +199 -0
  391. data/lib/docusign_esign/models/billing_plan_update_response.rb +247 -0
  392. data/lib/docusign_esign/models/billing_plans_response.rb +190 -0
  393. data/lib/docusign_esign/models/billing_price.rb +208 -0
  394. data/lib/docusign_esign/models/brand.rb +313 -0
  395. data/lib/docusign_esign/models/brand_email_content.rb +218 -0
  396. data/lib/docusign_esign/models/brand_link.rb +218 -0
  397. data/lib/docusign_esign/models/brand_logos.rb +208 -0
  398. data/lib/docusign_esign/models/brand_request.rb +188 -0
  399. data/lib/docusign_esign/models/brand_resource_urls.rb +218 -0
  400. data/lib/docusign_esign/models/brand_resources.rb +248 -0
  401. data/lib/docusign_esign/models/brand_resources_list.rb +190 -0
  402. data/lib/docusign_esign/models/brands_request.rb +190 -0
  403. data/lib/docusign_esign/models/brands_response.rb +210 -0
  404. data/lib/docusign_esign/models/bulk_envelope.rb +267 -0
  405. data/lib/docusign_esign/models/bulk_envelope_status.rb +320 -0
  406. data/lib/docusign_esign/models/bulk_envelopes_response.rb +250 -0
  407. data/lib/docusign_esign/models/bulk_recipient.rb +284 -0
  408. data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +198 -0
  409. data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +198 -0
  410. data/lib/docusign_esign/models/bulk_recipients_request.rb +190 -0
  411. data/lib/docusign_esign/models/bulk_recipients_response.rb +250 -0
  412. data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +222 -0
  413. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +187 -0
  414. data/lib/docusign_esign/models/captive_recipient.rb +217 -0
  415. data/lib/docusign_esign/models/captive_recipient_information.rb +190 -0
  416. data/lib/docusign_esign/models/carbon_copy.rb +603 -0
  417. data/lib/docusign_esign/models/certified_delivery.rb +603 -0
  418. data/lib/docusign_esign/models/checkbox.rb +476 -0
  419. data/lib/docusign_esign/models/chunked_upload_part.rb +198 -0
  420. data/lib/docusign_esign/models/chunked_upload_request.rb +198 -0
  421. data/lib/docusign_esign/models/chunked_upload_response.rb +250 -0
  422. data/lib/docusign_esign/models/cloud_storage_provider.rb +227 -0
  423. data/lib/docusign_esign/models/cloud_storage_providers.rb +190 -0
  424. data/lib/docusign_esign/models/company.rb +566 -0
  425. data/lib/docusign_esign/models/composite_template.rb +231 -0
  426. data/lib/docusign_esign/models/connect_config_results.rb +200 -0
  427. data/lib/docusign_esign/models/connect_custom_configuration.rb +388 -0
  428. data/lib/docusign_esign/models/connect_debug_log.rb +227 -0
  429. data/lib/docusign_esign/models/connect_failure_filter.rb +200 -0
  430. data/lib/docusign_esign/models/connect_failure_result.rb +228 -0
  431. data/lib/docusign_esign/models/connect_failure_results.rb +190 -0
  432. data/lib/docusign_esign/models/connect_log.rb +360 -0
  433. data/lib/docusign_esign/models/connect_logs.rb +222 -0
  434. data/lib/docusign_esign/models/console_view_request.rb +198 -0
  435. data/lib/docusign_esign/models/consumer_disclosure.rb +478 -0
  436. data/lib/docusign_esign/models/contact.rb +269 -0
  437. data/lib/docusign_esign/models/contact_get_response.rb +250 -0
  438. data/lib/docusign_esign/models/contact_mod_request.rb +190 -0
  439. data/lib/docusign_esign/models/contact_update_response.rb +190 -0
  440. data/lib/docusign_esign/models/correct_view_request.rb +198 -0
  441. data/lib/docusign_esign/models/country.rb +220 -0
  442. data/lib/docusign_esign/models/credit_card_information.rb +237 -0
  443. data/lib/docusign_esign/models/credit_card_types.rb +190 -0
  444. data/lib/docusign_esign/models/currency_feature_set_price.rb +228 -0
  445. data/lib/docusign_esign/models/currency_plan_price.rb +237 -0
  446. data/lib/docusign_esign/models/custom_field_v2.rb +247 -0
  447. data/lib/docusign_esign/models/custom_fields.rb +202 -0
  448. data/lib/docusign_esign/models/custom_fields_envelope.rb +202 -0
  449. data/lib/docusign_esign/models/custom_settings_information.rb +190 -0
  450. data/lib/docusign_esign/models/date.rb +626 -0
  451. data/lib/docusign_esign/models/date_signed.rb +496 -0
  452. data/lib/docusign_esign/models/decline.rb +516 -0
  453. data/lib/docusign_esign/models/diagnostics_settings_information.rb +208 -0
  454. data/lib/docusign_esign/models/dob_information_input.rb +208 -0
  455. data/lib/docusign_esign/models/document.rb +382 -0
  456. data/lib/docusign_esign/models/document_fields_information.rb +190 -0
  457. data/lib/docusign_esign/models/document_template.rb +227 -0
  458. data/lib/docusign_esign/models/document_template_list.rb +190 -0
  459. data/lib/docusign_esign/models/document_visibility.rb +227 -0
  460. data/lib/docusign_esign/models/document_visibility_list.rb +190 -0
  461. data/lib/docusign_esign/models/e_note_configuration.rb +228 -0
  462. data/lib/docusign_esign/models/editor.rb +591 -0
  463. data/lib/docusign_esign/models/email.rb +626 -0
  464. data/lib/docusign_esign/models/email_address.rb +486 -0
  465. data/lib/docusign_esign/models/email_settings.rb +210 -0
  466. data/lib/docusign_esign/models/envelope.rb +643 -0
  467. data/lib/docusign_esign/models/envelope_attachment.rb +237 -0
  468. data/lib/docusign_esign/models/envelope_attachments_request.rb +190 -0
  469. data/lib/docusign_esign/models/envelope_attachments_result.rb +190 -0
  470. data/lib/docusign_esign/models/envelope_audit_event.rb +190 -0
  471. data/lib/docusign_esign/models/envelope_audit_event_response.rb +190 -0
  472. data/lib/docusign_esign/models/envelope_definition.rb +740 -0
  473. data/lib/docusign_esign/models/envelope_document.rb +351 -0
  474. data/lib/docusign_esign/models/envelope_documents_result.rb +200 -0
  475. data/lib/docusign_esign/models/envelope_event.rb +198 -0
  476. data/lib/docusign_esign/models/envelope_form_data.rb +242 -0
  477. data/lib/docusign_esign/models/envelope_id.rb +486 -0
  478. data/lib/docusign_esign/models/envelope_ids_request.rb +202 -0
  479. data/lib/docusign_esign/models/envelope_notification_request.rb +206 -0
  480. data/lib/docusign_esign/models/envelope_summary.rb +218 -0
  481. data/lib/docusign_esign/models/envelope_template.rb +664 -0
  482. data/lib/docusign_esign/models/envelope_template_definition.rb +326 -0
  483. data/lib/docusign_esign/models/envelope_template_result.rb +784 -0
  484. data/lib/docusign_esign/models/envelope_template_results.rb +262 -0
  485. data/lib/docusign_esign/models/envelope_transaction_status.rb +217 -0
  486. data/lib/docusign_esign/models/envelope_update_summary.rb +260 -0
  487. data/lib/docusign_esign/models/envelopes_information.rb +262 -0
  488. data/lib/docusign_esign/models/error_details.rb +198 -0
  489. data/lib/docusign_esign/models/event_notification.rb +332 -0
  490. data/lib/docusign_esign/models/event_result.rb +218 -0
  491. data/lib/docusign_esign/models/expirations.rb +208 -0
  492. data/lib/docusign_esign/models/external_doc_service_error_details.rb +208 -0
  493. data/lib/docusign_esign/models/external_file.rb +258 -0
  494. data/lib/docusign_esign/models/external_folder.rb +279 -0
  495. data/lib/docusign_esign/models/feature_set.rb +270 -0
  496. data/lib/docusign_esign/models/file_type.rb +198 -0
  497. data/lib/docusign_esign/models/file_type_list.rb +190 -0
  498. data/lib/docusign_esign/models/filter.rb +288 -0
  499. data/lib/docusign_esign/models/first_name.rb +486 -0
  500. data/lib/docusign_esign/models/folder.rb +298 -0
  501. data/lib/docusign_esign/models/folder_item.rb +390 -0
  502. data/lib/docusign_esign/models/folder_item_response.rb +250 -0
  503. data/lib/docusign_esign/models/folder_item_v2.rb +377 -0
  504. data/lib/docusign_esign/models/folder_items_response.rb +250 -0
  505. data/lib/docusign_esign/models/folders_request.rb +200 -0
  506. data/lib/docusign_esign/models/folders_response.rb +190 -0
  507. data/lib/docusign_esign/models/forgotten_password_information.rb +258 -0
  508. data/lib/docusign_esign/models/formula_tab.rb +665 -0
  509. data/lib/docusign_esign/models/full_name.rb +486 -0
  510. data/lib/docusign_esign/models/group.rb +239 -0
  511. data/lib/docusign_esign/models/group_information.rb +250 -0
  512. data/lib/docusign_esign/models/id_check_information_input.rb +214 -0
  513. data/lib/docusign_esign/models/in_person_signer.rb +729 -0
  514. data/lib/docusign_esign/models/initial_here.rb +446 -0
  515. data/lib/docusign_esign/models/inline_template.rb +227 -0
  516. data/lib/docusign_esign/models/integrated_user_info_list.rb +260 -0
  517. data/lib/docusign_esign/models/intermediary.rb +603 -0
  518. data/lib/docusign_esign/models/last_name.rb +486 -0
  519. data/lib/docusign_esign/models/list.rb +568 -0
  520. data/lib/docusign_esign/models/list_custom_field.rb +259 -0
  521. data/lib/docusign_esign/models/list_item.rb +208 -0
  522. data/lib/docusign_esign/models/lock_information.rb +256 -0
  523. data/lib/docusign_esign/models/lock_request.rb +228 -0
  524. data/lib/docusign_esign/models/login_account.rb +292 -0
  525. data/lib/docusign_esign/models/login_information.rb +200 -0
  526. data/lib/docusign_esign/models/match_box.rb +228 -0
  527. data/lib/docusign_esign/models/member_group_shared_item.rb +206 -0
  528. data/lib/docusign_esign/models/member_shared_items.rb +220 -0
  529. data/lib/docusign_esign/models/merge_field.rb +228 -0
  530. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +207 -0
  531. data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +190 -0
  532. data/lib/docusign_esign/models/money.rb +208 -0
  533. data/lib/docusign_esign/models/name_value.rb +217 -0
  534. data/lib/docusign_esign/models/new_account_definition.rb +274 -0
  535. data/lib/docusign_esign/models/new_account_summary.rb +247 -0
  536. data/lib/docusign_esign/models/new_user.rb +277 -0
  537. data/lib/docusign_esign/models/new_users_definition.rb +190 -0
  538. data/lib/docusign_esign/models/new_users_summary.rb +190 -0
  539. data/lib/docusign_esign/models/notary_host.rb +577 -0
  540. data/lib/docusign_esign/models/note.rb +526 -0
  541. data/lib/docusign_esign/models/notification.rb +206 -0
  542. data/lib/docusign_esign/models/number.rb +646 -0
  543. data/lib/docusign_esign/models/oauth_access.rb +240 -0
  544. data/lib/docusign_esign/models/offline_attributes.rb +238 -0
  545. data/lib/docusign_esign/models/page.rb +257 -0
  546. data/lib/docusign_esign/models/page_images.rb +250 -0
  547. data/lib/docusign_esign/models/page_request.rb +198 -0
  548. data/lib/docusign_esign/models/payment_details.rb +229 -0
  549. data/lib/docusign_esign/models/payment_line_item.rb +218 -0
  550. data/lib/docusign_esign/models/permission_profile.rb +249 -0
  551. data/lib/docusign_esign/models/permission_profile_information.rb +190 -0
  552. data/lib/docusign_esign/models/plan_information.rb +244 -0
  553. data/lib/docusign_esign/models/post_transactions_request.rb +218 -0
  554. data/lib/docusign_esign/models/post_transactions_response.rb +198 -0
  555. data/lib/docusign_esign/models/power_form.rb +421 -0
  556. data/lib/docusign_esign/models/power_form_form_data_envelope.rb +200 -0
  557. data/lib/docusign_esign/models/power_form_form_data_recipient.rb +220 -0
  558. data/lib/docusign_esign/models/power_form_recipient.rb +308 -0
  559. data/lib/docusign_esign/models/power_form_senders_response.rb +250 -0
  560. data/lib/docusign_esign/models/power_forms_form_data_response.rb +190 -0
  561. data/lib/docusign_esign/models/power_forms_request.rb +190 -0
  562. data/lib/docusign_esign/models/power_forms_response.rb +250 -0
  563. data/lib/docusign_esign/models/property_metadata.rb +200 -0
  564. data/lib/docusign_esign/models/province.rb +198 -0
  565. data/lib/docusign_esign/models/provisioning_information.rb +248 -0
  566. data/lib/docusign_esign/models/purchased_envelopes_information.rb +268 -0
  567. data/lib/docusign_esign/models/radio.rb +357 -0
  568. data/lib/docusign_esign/models/radio_group.rb +270 -0
  569. data/lib/docusign_esign/models/recipient_attachment.rb +238 -0
  570. data/lib/docusign_esign/models/recipient_domain.rb +218 -0
  571. data/lib/docusign_esign/models/recipient_email_notification.rb +208 -0
  572. data/lib/docusign_esign/models/recipient_event.rb +198 -0
  573. data/lib/docusign_esign/models/recipient_form_data.rb +260 -0
  574. data/lib/docusign_esign/models/recipient_names_response.rb +210 -0
  575. data/lib/docusign_esign/models/recipient_phone_authentication.rb +220 -0
  576. data/lib/docusign_esign/models/recipient_saml_authentication.rb +190 -0
  577. data/lib/docusign_esign/models/recipient_signature_information.rb +208 -0
  578. data/lib/docusign_esign/models/recipient_signature_provider.rb +197 -0
  579. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +218 -0
  580. data/lib/docusign_esign/models/recipient_sms_authentication.rb +190 -0
  581. data/lib/docusign_esign/models/recipient_update_response.rb +206 -0
  582. data/lib/docusign_esign/models/recipient_view_request.rb +318 -0
  583. data/lib/docusign_esign/models/recipients.rb +291 -0
  584. data/lib/docusign_esign/models/recipients_update_summary.rb +190 -0
  585. data/lib/docusign_esign/models/referral_information.rb +358 -0
  586. data/lib/docusign_esign/models/reminders.rb +208 -0
  587. data/lib/docusign_esign/models/resource_information.rb +190 -0
  588. data/lib/docusign_esign/models/return_url_request.rb +188 -0
  589. data/lib/docusign_esign/models/saml_assertion_attribute.rb +217 -0
  590. data/lib/docusign_esign/models/seat_discount.rb +208 -0
  591. data/lib/docusign_esign/models/sender_email_notifications.rb +248 -0
  592. data/lib/docusign_esign/models/server_template.rb +198 -0
  593. data/lib/docusign_esign/models/service_information.rb +242 -0
  594. data/lib/docusign_esign/models/service_version.rb +198 -0
  595. data/lib/docusign_esign/models/settings_metadata.rb +240 -0
  596. data/lib/docusign_esign/models/shared_item.rb +206 -0
  597. data/lib/docusign_esign/models/sign_here.rb +446 -0
  598. data/lib/docusign_esign/models/signature_provider_required_option.rb +200 -0
  599. data/lib/docusign_esign/models/signature_type.rb +198 -0
  600. data/lib/docusign_esign/models/signer.rb +742 -0
  601. data/lib/docusign_esign/models/signer_attachment.rb +446 -0
  602. data/lib/docusign_esign/models/signer_email_notifications.rb +318 -0
  603. data/lib/docusign_esign/models/signing_group.rb +279 -0
  604. data/lib/docusign_esign/models/signing_group_information.rb +190 -0
  605. data/lib/docusign_esign/models/signing_group_user.rb +207 -0
  606. data/lib/docusign_esign/models/signing_group_users.rb +190 -0
  607. data/lib/docusign_esign/models/social_account_information.rb +227 -0
  608. data/lib/docusign_esign/models/social_authentication.rb +188 -0
  609. data/lib/docusign_esign/models/ssn.rb +626 -0
  610. data/lib/docusign_esign/models/ssn4_information_input.rb +208 -0
  611. data/lib/docusign_esign/models/ssn9_information_input.rb +198 -0
  612. data/lib/docusign_esign/models/tab_account_settings.rb +539 -0
  613. data/lib/docusign_esign/models/tab_metadata.rb +569 -0
  614. data/lib/docusign_esign/models/tab_metadata_list.rb +190 -0
  615. data/lib/docusign_esign/models/tabs.rb +478 -0
  616. data/lib/docusign_esign/models/template_custom_fields.rb +202 -0
  617. data/lib/docusign_esign/models/template_document_visibility_list.rb +190 -0
  618. data/lib/docusign_esign/models/template_documents_result.rb +200 -0
  619. data/lib/docusign_esign/models/template_information.rb +190 -0
  620. data/lib/docusign_esign/models/template_match.rb +208 -0
  621. data/lib/docusign_esign/models/template_notification_request.rb +216 -0
  622. data/lib/docusign_esign/models/template_recipients.rb +291 -0
  623. data/lib/docusign_esign/models/template_role.rb +296 -0
  624. data/lib/docusign_esign/models/template_shared_item.rb +250 -0
  625. data/lib/docusign_esign/models/template_summary.rb +247 -0
  626. data/lib/docusign_esign/models/template_tabs.rb +478 -0
  627. data/lib/docusign_esign/models/template_update_summary.rb +260 -0
  628. data/lib/docusign_esign/models/text.rb +656 -0
  629. data/lib/docusign_esign/models/text_custom_field.rb +247 -0
  630. data/lib/docusign_esign/models/title.rb +566 -0
  631. data/lib/docusign_esign/models/usage_history.rb +218 -0
  632. data/lib/docusign_esign/models/user_account_management_granular_information.rb +254 -0
  633. data/lib/docusign_esign/models/user_info.rb +277 -0
  634. data/lib/docusign_esign/models/user_info_list.rb +190 -0
  635. data/lib/docusign_esign/models/user_information.rb +519 -0
  636. data/lib/docusign_esign/models/user_information_list.rb +250 -0
  637. data/lib/docusign_esign/models/user_password_information.rb +217 -0
  638. data/lib/docusign_esign/models/user_profile.rb +297 -0
  639. data/lib/docusign_esign/models/user_settings_information.rb +217 -0
  640. data/lib/docusign_esign/models/user_shared_item.rb +206 -0
  641. data/lib/docusign_esign/models/user_signature.rb +307 -0
  642. data/lib/docusign_esign/models/user_signature_definition.rb +218 -0
  643. data/lib/docusign_esign/models/user_signatures_information.rb +190 -0
  644. data/lib/docusign_esign/models/user_social_id_result.rb +200 -0
  645. data/lib/docusign_esign/models/users_response.rb +250 -0
  646. data/lib/docusign_esign/models/view.rb +526 -0
  647. data/lib/docusign_esign/models/view_link_request.rb +198 -0
  648. data/lib/docusign_esign/models/view_url.rb +188 -0
  649. data/lib/docusign_esign/models/workspace.rb +286 -0
  650. data/lib/docusign_esign/models/workspace_folder_contents.rb +261 -0
  651. data/lib/docusign_esign/models/workspace_item.rb +365 -0
  652. data/lib/docusign_esign/models/workspace_item_list.rb +190 -0
  653. data/lib/docusign_esign/models/workspace_list.rb +230 -0
  654. data/lib/docusign_esign/models/workspace_user.rb +337 -0
  655. data/lib/docusign_esign/models/workspace_user_authorization.rb +286 -0
  656. data/lib/docusign_esign/models/zip.rb +636 -0
  657. data/lib/docusign_esign/version.rb +14 -0
  658. data/lib/docusign_esign.rb +360 -0
  659. data/spec/api/accounts_api_spec.rb +556 -0
  660. data/spec/api/authentication_api_spec.rb +125 -0
  661. data/spec/api/billing_api_spec.rb +178 -0
  662. data/spec/api/bulk_envelopes_api_spec.rb +110 -0
  663. data/spec/api/cloud_storage_api_spec.rb +146 -0
  664. data/spec/api/connect_api_spec.rb +261 -0
  665. data/spec/api/custom_tabs_api_spec.rb +100 -0
  666. data/spec/api/diagnostics_api_spec.rb +114 -0
  667. data/spec/api/envelopes_api_spec.rb +1171 -0
  668. data/spec/api/folders_api_spec.rb +107 -0
  669. data/spec/api/groups_api_spec.rb +174 -0
  670. data/spec/api/power_forms_api_spec.rb +144 -0
  671. data/spec/api/signing_groups_api_spec.rb +155 -0
  672. data/spec/api/templates_api_spec.rb +649 -0
  673. data/spec/api/users_api_spec.rb +442 -0
  674. data/spec/api/workspaces_api_spec.rb +201 -0
  675. data/spec/api_client_spec.rb +225 -0
  676. data/spec/configuration_spec.rb +41 -0
  677. data/spec/models/account_address_spec.rb +107 -0
  678. data/spec/models/account_billing_plan_response_spec.rb +71 -0
  679. data/spec/models/account_billing_plan_spec.rb +155 -0
  680. data/spec/models/account_information_spec.rb +221 -0
  681. data/spec/models/account_role_settings_spec.rb +419 -0
  682. data/spec/models/account_settings_information_spec.rb +41 -0
  683. data/spec/models/account_shared_access_spec.rb +89 -0
  684. data/spec/models/account_signature_provider_option_spec.rb +53 -0
  685. data/spec/models/account_signature_provider_spec.rb +77 -0
  686. data/spec/models/account_signature_providers_spec.rb +41 -0
  687. data/spec/models/add_on_spec.rb +59 -0
  688. data/spec/models/address_information_input_spec.rb +53 -0
  689. data/spec/models/address_information_spec.rb +83 -0
  690. data/spec/models/address_information_v2_spec.rb +83 -0
  691. data/spec/models/agent_spec.rb +287 -0
  692. data/spec/models/api_request_log_spec.rb +59 -0
  693. data/spec/models/api_request_logs_result_spec.rb +41 -0
  694. data/spec/models/app_store_product_spec.rb +47 -0
  695. data/spec/models/app_store_receipt_spec.rb +47 -0
  696. data/spec/models/approve_spec.rb +233 -0
  697. data/spec/models/attachment_spec.rb +77 -0
  698. data/spec/models/authentication_method_spec.rb +59 -0
  699. data/spec/models/authentication_status_spec.rb +137 -0
  700. data/spec/models/bcc_email_address_spec.rb +47 -0
  701. data/spec/models/billing_charge_response_spec.rb +41 -0
  702. data/spec/models/billing_charge_spec.rb +113 -0
  703. data/spec/models/billing_discount_spec.rb +53 -0
  704. data/spec/models/billing_invoice_item_spec.rb +65 -0
  705. data/spec/models/billing_invoice_spec.rb +95 -0
  706. data/spec/models/billing_invoices_response_spec.rb +53 -0
  707. data/spec/models/billing_invoices_summary_spec.rb +53 -0
  708. data/spec/models/billing_payment_item_spec.rb +65 -0
  709. data/spec/models/billing_payment_request_spec.rb +41 -0
  710. data/spec/models/billing_payment_response_spec.rb +41 -0
  711. data/spec/models/billing_payment_spec.rb +53 -0
  712. data/spec/models/billing_payments_response_spec.rb +53 -0
  713. data/spec/models/billing_plan_information_spec.rb +125 -0
  714. data/spec/models/billing_plan_preview_spec.rb +71 -0
  715. data/spec/models/billing_plan_response_spec.rb +47 -0
  716. data/spec/models/billing_plan_spec.rb +125 -0
  717. data/spec/models/billing_plan_update_response_spec.rb +77 -0
  718. data/spec/models/billing_plans_response_spec.rb +41 -0
  719. data/spec/models/billing_price_spec.rb +53 -0
  720. data/spec/models/brand_email_content_spec.rb +59 -0
  721. data/spec/models/brand_link_spec.rb +59 -0
  722. data/spec/models/brand_logos_spec.rb +53 -0
  723. data/spec/models/brand_request_spec.rb +41 -0
  724. data/spec/models/brand_resource_urls_spec.rb +59 -0
  725. data/spec/models/brand_resources_list_spec.rb +41 -0
  726. data/spec/models/brand_resources_spec.rb +77 -0
  727. data/spec/models/brand_spec.rb +113 -0
  728. data/spec/models/brands_request_spec.rb +41 -0
  729. data/spec/models/brands_response_spec.rb +53 -0
  730. data/spec/models/bulk_envelope_spec.rb +89 -0
  731. data/spec/models/bulk_envelope_status_spec.rb +119 -0
  732. data/spec/models/bulk_envelopes_response_spec.rb +77 -0
  733. data/spec/models/bulk_recipient_signature_provider_spec.rb +47 -0
  734. data/spec/models/bulk_recipient_spec.rb +95 -0
  735. data/spec/models/bulk_recipient_tab_label_spec.rb +47 -0
  736. data/spec/models/bulk_recipients_request_spec.rb +41 -0
  737. data/spec/models/bulk_recipients_response_spec.rb +77 -0
  738. data/spec/models/bulk_recipients_summary_response_spec.rb +59 -0
  739. data/spec/models/bulk_recipients_update_response_spec.rb +41 -0
  740. data/spec/models/captive_recipient_information_spec.rb +41 -0
  741. data/spec/models/captive_recipient_spec.rb +59 -0
  742. data/spec/models/carbon_copy_spec.rb +287 -0
  743. data/spec/models/certified_delivery_spec.rb +287 -0
  744. data/spec/models/checkbox_spec.rb +215 -0
  745. data/spec/models/chunked_upload_part_spec.rb +47 -0
  746. data/spec/models/chunked_upload_request_spec.rb +47 -0
  747. data/spec/models/chunked_upload_response_spec.rb +77 -0
  748. data/spec/models/cloud_storage_provider_spec.rb +65 -0
  749. data/spec/models/cloud_storage_providers_spec.rb +41 -0
  750. data/spec/models/company_spec.rb +269 -0
  751. data/spec/models/composite_template_spec.rb +65 -0
  752. data/spec/models/connect_config_results_spec.rb +47 -0
  753. data/spec/models/connect_custom_configuration_spec.rb +161 -0
  754. data/spec/models/connect_debug_log_spec.rb +65 -0
  755. data/spec/models/connect_failure_filter_spec.rb +47 -0
  756. data/spec/models/connect_failure_result_spec.rb +65 -0
  757. data/spec/models/connect_failure_results_spec.rb +41 -0
  758. data/spec/models/connect_log_spec.rb +143 -0
  759. data/spec/models/connect_logs_spec.rb +59 -0
  760. data/spec/models/console_view_request_spec.rb +47 -0
  761. data/spec/models/consumer_disclosure_spec.rb +215 -0
  762. data/spec/models/contact_get_response_spec.rb +77 -0
  763. data/spec/models/contact_mod_request_spec.rb +41 -0
  764. data/spec/models/contact_spec.rb +89 -0
  765. data/spec/models/contact_update_response_spec.rb +41 -0
  766. data/spec/models/correct_view_request_spec.rb +47 -0
  767. data/spec/models/country_spec.rb +59 -0
  768. data/spec/models/credit_card_information_spec.rb +71 -0
  769. data/spec/models/credit_card_types_spec.rb +41 -0
  770. data/spec/models/currency_feature_set_price_spec.rb +65 -0
  771. data/spec/models/currency_plan_price_spec.rb +71 -0
  772. data/spec/models/custom_field_v2_spec.rb +77 -0
  773. data/spec/models/custom_fields_envelope_spec.rb +47 -0
  774. data/spec/models/custom_fields_spec.rb +47 -0
  775. data/spec/models/custom_settings_information_spec.rb +41 -0
  776. data/spec/models/date_signed_spec.rb +227 -0
  777. data/spec/models/date_spec.rb +305 -0
  778. data/spec/models/decline_spec.rb +239 -0
  779. data/spec/models/diagnostics_settings_information_spec.rb +53 -0
  780. data/spec/models/dob_information_input_spec.rb +53 -0
  781. data/spec/models/document_fields_information_spec.rb +41 -0
  782. data/spec/models/document_spec.rb +155 -0
  783. data/spec/models/document_template_list_spec.rb +41 -0
  784. data/spec/models/document_template_spec.rb +65 -0
  785. data/spec/models/document_visibility_list_spec.rb +41 -0
  786. data/spec/models/document_visibility_spec.rb +65 -0
  787. data/spec/models/e_note_configuration_spec.rb +65 -0
  788. data/spec/models/editor_spec.rb +281 -0
  789. data/spec/models/email_address_spec.rb +221 -0
  790. data/spec/models/email_settings_spec.rb +53 -0
  791. data/spec/models/email_spec.rb +305 -0
  792. data/spec/models/envelope_attachment_spec.rb +71 -0
  793. data/spec/models/envelope_attachments_request_spec.rb +41 -0
  794. data/spec/models/envelope_attachments_result_spec.rb +41 -0
  795. data/spec/models/envelope_audit_event_response_spec.rb +41 -0
  796. data/spec/models/envelope_audit_event_spec.rb +41 -0
  797. data/spec/models/envelope_definition_spec.rb +371 -0
  798. data/spec/models/envelope_document_spec.rb +137 -0
  799. data/spec/models/envelope_documents_result_spec.rb +47 -0
  800. data/spec/models/envelope_event_spec.rb +47 -0
  801. data/spec/models/envelope_form_data_spec.rb +71 -0
  802. data/spec/models/envelope_id_spec.rb +221 -0
  803. data/spec/models/envelope_ids_request_spec.rb +47 -0
  804. data/spec/models/envelope_notification_request_spec.rb +53 -0
  805. data/spec/models/envelope_spec.rb +317 -0
  806. data/spec/models/envelope_summary_spec.rb +59 -0
  807. data/spec/models/envelope_template_definition_spec.rb +125 -0
  808. data/spec/models/envelope_template_result_spec.rb +401 -0
  809. data/spec/models/envelope_template_results_spec.rb +83 -0
  810. data/spec/models/envelope_template_spec.rb +329 -0
  811. data/spec/models/envelope_transaction_status_spec.rb +59 -0
  812. data/spec/models/envelope_update_summary_spec.rb +83 -0
  813. data/spec/models/envelopes_information_spec.rb +83 -0
  814. data/spec/models/error_details_spec.rb +47 -0
  815. data/spec/models/event_notification_spec.rb +125 -0
  816. data/spec/models/event_result_spec.rb +59 -0
  817. data/spec/models/expirations_spec.rb +53 -0
  818. data/spec/models/external_doc_service_error_details_spec.rb +53 -0
  819. data/spec/models/external_file_spec.rb +83 -0
  820. data/spec/models/external_folder_spec.rb +95 -0
  821. data/spec/models/feature_set_spec.rb +89 -0
  822. data/spec/models/file_type_list_spec.rb +41 -0
  823. data/spec/models/file_type_spec.rb +47 -0
  824. data/spec/models/filter_spec.rb +101 -0
  825. data/spec/models/first_name_spec.rb +221 -0
  826. data/spec/models/folder_item_response_spec.rb +77 -0
  827. data/spec/models/folder_item_spec.rb +161 -0
  828. data/spec/models/folder_item_v2_spec.rb +155 -0
  829. data/spec/models/folder_items_response_spec.rb +77 -0
  830. data/spec/models/folder_spec.rb +107 -0
  831. data/spec/models/folders_request_spec.rb +47 -0
  832. data/spec/models/folders_response_spec.rb +41 -0
  833. data/spec/models/forgotten_password_information_spec.rb +83 -0
  834. data/spec/models/formula_tab_spec.rb +329 -0
  835. data/spec/models/full_name_spec.rb +221 -0
  836. data/spec/models/group_information_spec.rb +77 -0
  837. data/spec/models/group_spec.rb +71 -0
  838. data/spec/models/id_check_information_input_spec.rb +59 -0
  839. data/spec/models/in_person_signer_spec.rb +365 -0
  840. data/spec/models/initial_here_spec.rb +197 -0
  841. data/spec/models/inline_template_spec.rb +65 -0
  842. data/spec/models/integrated_user_info_list_spec.rb +83 -0
  843. data/spec/models/intermediary_spec.rb +287 -0
  844. data/spec/models/last_name_spec.rb +221 -0
  845. data/spec/models/list_custom_field_spec.rb +83 -0
  846. data/spec/models/list_item_spec.rb +53 -0
  847. data/spec/models/list_spec.rb +269 -0
  848. data/spec/models/lock_information_spec.rb +83 -0
  849. data/spec/models/lock_request_spec.rb +65 -0
  850. data/spec/models/login_account_spec.rb +101 -0
  851. data/spec/models/login_information_spec.rb +47 -0
  852. data/spec/models/match_box_spec.rb +65 -0
  853. data/spec/models/member_group_shared_item_spec.rb +53 -0
  854. data/spec/models/member_shared_items_spec.rb +59 -0
  855. data/spec/models/merge_field_spec.rb +65 -0
  856. data/spec/models/mobile_notifier_configuration_information_spec.rb +41 -0
  857. data/spec/models/mobile_notifier_configuration_spec.rb +53 -0
  858. data/spec/models/money_spec.rb +53 -0
  859. data/spec/models/name_value_spec.rb +59 -0
  860. data/spec/models/new_account_definition_spec.rb +95 -0
  861. data/spec/models/new_account_summary_spec.rb +77 -0
  862. data/spec/models/new_user_spec.rb +95 -0
  863. data/spec/models/new_users_definition_spec.rb +41 -0
  864. data/spec/models/new_users_summary_spec.rb +41 -0
  865. data/spec/models/notary_host_spec.rb +275 -0
  866. data/spec/models/note_spec.rb +245 -0
  867. data/spec/models/notification_spec.rb +53 -0
  868. data/spec/models/number_spec.rb +317 -0
  869. data/spec/models/oauth_access_spec.rb +71 -0
  870. data/spec/models/offline_attributes_spec.rb +71 -0
  871. data/spec/models/page_images_spec.rb +77 -0
  872. data/spec/models/page_request_spec.rb +47 -0
  873. data/spec/models/page_spec.rb +83 -0
  874. data/spec/models/payment_details_spec.rb +65 -0
  875. data/spec/models/payment_line_item_spec.rb +59 -0
  876. data/spec/models/permission_profile_information_spec.rb +41 -0
  877. data/spec/models/permission_profile_spec.rb +77 -0
  878. data/spec/models/plan_information_spec.rb +71 -0
  879. data/spec/models/post_transactions_request_spec.rb +59 -0
  880. data/spec/models/post_transactions_response_spec.rb +47 -0
  881. data/spec/models/power_form_form_data_envelope_spec.rb +47 -0
  882. data/spec/models/power_form_form_data_recipient_spec.rb +59 -0
  883. data/spec/models/power_form_recipient_spec.rb +113 -0
  884. data/spec/models/power_form_senders_response_spec.rb +77 -0
  885. data/spec/models/power_form_spec.rb +179 -0
  886. data/spec/models/power_forms_form_data_response_spec.rb +41 -0
  887. data/spec/models/power_forms_request_spec.rb +41 -0
  888. data/spec/models/power_forms_response_spec.rb +77 -0
  889. data/spec/models/property_metadata_spec.rb +47 -0
  890. data/spec/models/province_spec.rb +47 -0
  891. data/spec/models/provisioning_information_spec.rb +77 -0
  892. data/spec/models/purchased_envelopes_information_spec.rb +89 -0
  893. data/spec/models/radio_group_spec.rb +89 -0
  894. data/spec/models/radio_spec.rb +143 -0
  895. data/spec/models/recipient_attachment_spec.rb +71 -0
  896. data/spec/models/recipient_domain_spec.rb +59 -0
  897. data/spec/models/recipient_email_notification_spec.rb +53 -0
  898. data/spec/models/recipient_event_spec.rb +47 -0
  899. data/spec/models/recipient_form_data_spec.rb +83 -0
  900. data/spec/models/recipient_names_response_spec.rb +53 -0
  901. data/spec/models/recipient_phone_authentication_spec.rb +59 -0
  902. data/spec/models/recipient_saml_authentication_spec.rb +41 -0
  903. data/spec/models/recipient_signature_information_spec.rb +53 -0
  904. data/spec/models/recipient_signature_provider_options_spec.rb +59 -0
  905. data/spec/models/recipient_signature_provider_spec.rb +47 -0
  906. data/spec/models/recipient_sms_authentication_spec.rb +41 -0
  907. data/spec/models/recipient_update_response_spec.rb +53 -0
  908. data/spec/models/recipient_view_request_spec.rb +119 -0
  909. data/spec/models/recipients_spec.rb +95 -0
  910. data/spec/models/recipients_update_summary_spec.rb +41 -0
  911. data/spec/models/referral_information_spec.rb +143 -0
  912. data/spec/models/reminders_spec.rb +53 -0
  913. data/spec/models/resource_information_spec.rb +41 -0
  914. data/spec/models/return_url_request_spec.rb +41 -0
  915. data/spec/models/saml_assertion_attribute_spec.rb +59 -0
  916. data/spec/models/seat_discount_spec.rb +53 -0
  917. data/spec/models/sender_email_notifications_spec.rb +77 -0
  918. data/spec/models/server_template_spec.rb +47 -0
  919. data/spec/models/service_information_spec.rb +71 -0
  920. data/spec/models/service_version_spec.rb +47 -0
  921. data/spec/models/settings_metadata_spec.rb +71 -0
  922. data/spec/models/shared_item_spec.rb +53 -0
  923. data/spec/models/sign_here_spec.rb +197 -0
  924. data/spec/models/signature_provider_required_option_spec.rb +47 -0
  925. data/spec/models/signature_type_spec.rb +47 -0
  926. data/spec/models/signer_attachment_spec.rb +197 -0
  927. data/spec/models/signer_email_notifications_spec.rb +119 -0
  928. data/spec/models/signer_spec.rb +371 -0
  929. data/spec/models/signing_group_information_spec.rb +41 -0
  930. data/spec/models/signing_group_spec.rb +95 -0
  931. data/spec/models/signing_group_user_spec.rb +53 -0
  932. data/spec/models/signing_group_users_spec.rb +41 -0
  933. data/spec/models/social_account_information_spec.rb +65 -0
  934. data/spec/models/social_authentication_spec.rb +41 -0
  935. data/spec/models/ssn4_information_input_spec.rb +53 -0
  936. data/spec/models/ssn9_information_input_spec.rb +47 -0
  937. data/spec/models/ssn_spec.rb +305 -0
  938. data/spec/models/tab_account_settings_spec.rb +263 -0
  939. data/spec/models/tab_metadata_list_spec.rb +41 -0
  940. data/spec/models/tab_metadata_spec.rb +269 -0
  941. data/spec/models/tabs_spec.rb +185 -0
  942. data/spec/models/template_custom_fields_spec.rb +47 -0
  943. data/spec/models/template_document_visibility_list_spec.rb +41 -0
  944. data/spec/models/template_documents_result_spec.rb +47 -0
  945. data/spec/models/template_information_spec.rb +41 -0
  946. data/spec/models/template_match_spec.rb +53 -0
  947. data/spec/models/template_notification_request_spec.rb +59 -0
  948. data/spec/models/template_recipients_spec.rb +95 -0
  949. data/spec/models/template_role_spec.rb +107 -0
  950. data/spec/models/template_shared_item_spec.rb +77 -0
  951. data/spec/models/template_summary_spec.rb +77 -0
  952. data/spec/models/template_tabs_spec.rb +185 -0
  953. data/spec/models/template_update_summary_spec.rb +83 -0
  954. data/spec/models/text_custom_field_spec.rb +77 -0
  955. data/spec/models/text_spec.rb +323 -0
  956. data/spec/models/title_spec.rb +269 -0
  957. data/spec/models/usage_history_spec.rb +59 -0
  958. data/spec/models/user_account_management_granular_information_spec.rb +83 -0
  959. data/spec/models/user_info_list_spec.rb +41 -0
  960. data/spec/models/user_info_spec.rb +95 -0
  961. data/spec/models/user_information_list_spec.rb +77 -0
  962. data/spec/models/user_information_spec.rb +239 -0
  963. data/spec/models/user_password_information_spec.rb +59 -0
  964. data/spec/models/user_profile_spec.rb +107 -0
  965. data/spec/models/user_settings_information_spec.rb +59 -0
  966. data/spec/models/user_shared_item_spec.rb +53 -0
  967. data/spec/models/user_signature_definition_spec.rb +59 -0
  968. data/spec/models/user_signature_spec.rb +113 -0
  969. data/spec/models/user_signatures_information_spec.rb +41 -0
  970. data/spec/models/user_social_id_result_spec.rb +47 -0
  971. data/spec/models/users_response_spec.rb +77 -0
  972. data/spec/models/view_link_request_spec.rb +47 -0
  973. data/spec/models/view_spec.rb +245 -0
  974. data/spec/models/view_url_spec.rb +41 -0
  975. data/spec/models/workspace_folder_contents_spec.rb +83 -0
  976. data/spec/models/workspace_item_list_spec.rb +41 -0
  977. data/spec/models/workspace_item_spec.rb +149 -0
  978. data/spec/models/workspace_list_spec.rb +65 -0
  979. data/spec/models/workspace_spec.rb +101 -0
  980. data/spec/models/workspace_user_authorization_spec.rb +101 -0
  981. data/spec/models/workspace_user_spec.rb +131 -0
  982. data/spec/models/zip_spec.rb +311 -0
  983. data/spec/spec_helper.rb +110 -0
  984. data/tests/.DS_Store +0 -0
  985. data/tests/Gemfile +5 -0
  986. data/tests/Gemfile.lock +42 -0
  987. data/tests/docs/Test.pdf +0 -0
  988. data/tests/rsa_keys/private.pem +27 -0
  989. data/tests/rsa_keys/public.pem +9 -0
  990. data/tests/spec/unit_tests_spec.rb +360 -0
  991. data/tests/spec/unit_tests_using_jwt_spec.rb +361 -0
  992. metadata +1560 -0
@@ -0,0 +1,24 @@
1
+ # DocuSign_eSign::EnvelopeDocument
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **attachment_tab_id** | **String** | | [optional]
7
+ **available_document_types** | [**Array<SignatureType>**](SignatureType.md) | | [optional]
8
+ **contains_pdf_form_fields** | **String** | | [optional]
9
+ **display** | **String** | | [optional]
10
+ **document_fields** | [**Array<NameValue>**](NameValue.md) | | [optional]
11
+ **document_group** | **String** | | [optional]
12
+ **document_id** | **String** | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. | [optional]
13
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
14
+ **include_in_download** | **String** | | [optional]
15
+ **name** | **String** | | [optional]
16
+ **order** | **String** | | [optional]
17
+ **pages** | **String** | | [optional]
18
+ **signer_must_acknowledge** | **String** | | [optional]
19
+ **template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
20
+ **template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
21
+ **type** | **String** | | [optional]
22
+ **uri** | **String** | | [optional]
23
+
24
+
@@ -0,0 +1,9 @@
1
+ # DocuSign_eSign::EnvelopeDocumentsResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **envelope_documents** | [**Array<EnvelopeDocument>**](EnvelopeDocument.md) | | [optional]
7
+ **envelope_id** | **String** | The envelope ID of the envelope status that failed to post. | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # DocuSign_eSign::EnvelopeEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **envelope_event_status_code** | **String** | he envelope status, this can be Sent, Delivered, Completed, Declined, or Voided. | [optional]
7
+ **include_documents** | **String** | When set to **true**, the PDF documents are included in the message along with the updated XML. | [optional]
8
+
9
+
@@ -0,0 +1,13 @@
1
+ # DocuSign_eSign::EnvelopeFormData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email_subject** | **String** | Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. | [optional]
7
+ **envelope_id** | **String** | The envelope ID of the envelope status that failed to post. | [optional]
8
+ **form_data** | [**Array<NameValue>**](NameValue.md) | | [optional]
9
+ **recipient_form_data** | [**Array<RecipientFormData>**](RecipientFormData.md) | | [optional]
10
+ **sent_date_time** | **String** | The date and time the envelope was sent. | [optional]
11
+ **status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
12
+
13
+
@@ -0,0 +1,38 @@
1
+ # DocuSign_eSign::EnvelopeId
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **anchor_case_sensitive** | **String** | When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. | [optional]
7
+ **anchor_horizontal_alignment** | **String** | Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. | [optional]
8
+ **anchor_ignore_if_not_present** | **String** | When set to **true**, this tab is ignored if anchorString is not found in the document. | [optional]
9
+ **anchor_match_whole_word** | **String** | When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. | [optional]
10
+ **anchor_string** | **String** | Anchor text information for a radio button. | [optional]
11
+ **anchor_units** | **String** | Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. | [optional]
12
+ **anchor_x_offset** | **String** | Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
13
+ **anchor_y_offset** | **String** | Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
14
+ **bold** | **String** | When set to **true**, the information in the tab is bold. | [optional]
15
+ **conditional_parent_label** | **String** | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | [optional]
16
+ **conditional_parent_value** | **String** | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. | [optional]
17
+ **custom_tab_id** | **String** | The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. | [optional]
18
+ **document_id** | **String** | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. | [optional]
19
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
20
+ **font** | **String** | The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. | [optional]
21
+ **font_color** | **String** | The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. | [optional]
22
+ **font_size** | **String** | The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. | [optional]
23
+ **italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
24
+ **merge_field** | [**MergeField**](MergeField.md) | | [optional]
25
+ **name** | **String** | | [optional]
26
+ **page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
27
+ **recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
28
+ **status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
29
+ **tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
30
+ **tab_label** | **String** | The label string associated with the tab. | [optional]
31
+ **tab_order** | **String** | | [optional]
32
+ **template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
33
+ **template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
34
+ **underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
35
+ **x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
36
+ **y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
37
+
38
+
@@ -0,0 +1,9 @@
1
+ # DocuSign_eSign::EnvelopeIdsRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **envelope_ids** | **Array<String>** | | [optional]
7
+ **transaction_ids** | **Array<String>** | A list of transaction Id's used to determining the status of envelopes sent asynchronously. See **transactionId** property on envelopes. | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # DocuSign_eSign::EnvelopeNotificationRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **expirations** | [**Expirations**](Expirations.md) | | [optional]
7
+ **reminders** | [**Reminders**](Reminders.md) | | [optional]
8
+ **use_account_defaults** | **String** | | [optional]
9
+
10
+
@@ -0,0 +1,11 @@
1
+ # DocuSign_eSign::EnvelopeSummary
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **envelope_id** | **String** | The envelope ID of the envelope status that failed to post. | [optional]
7
+ **status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
8
+ **status_date_time** | **String** | The DateTime that the envelope changed status (i.e. was created or sent.) | [optional]
9
+ **uri** | **String** | | [optional]
10
+
11
+
@@ -0,0 +1,56 @@
1
+ # DocuSign_eSign::EnvelopeTemplate
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **allow_markup** | **String** | When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this | [optional]
7
+ **allow_reassign** | **String** | When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. | [optional]
8
+ **asynchronous** | **String** | When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. | [optional]
9
+ **attachments_uri** | **String** | | [optional]
10
+ **authoritative_copy** | **String** | Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. | [optional]
11
+ **auto_navigation** | **String** | | [optional]
12
+ **brand_id** | **String** | | [optional]
13
+ **brand_lock** | **String** | | [optional]
14
+ **certificate_uri** | **String** | Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. | [optional]
15
+ **completed_date_time** | **String** | Specifies the date and time this item was completed. | [optional]
16
+ **created_date_time** | **String** | Indicates the date and time the item was created. | [optional]
17
+ **custom_fields** | [**CustomFields**](CustomFields.md) | | [optional]
18
+ **custom_fields_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the custom fields. | [optional]
19
+ **declined_date_time** | **String** | The date and time the recipient declined the document. | [optional]
20
+ **deleted_date_time** | **String** | Specifies the data and time the item was deleted. | [optional]
21
+ **delivered_date_time** | **String** | Reserved: For DocuSign use only. | [optional]
22
+ **documents** | [**Array<Document>**](Document.md) | Complex element contains the details on the documents in the envelope. | [optional]
23
+ **documents_combined_uri** | **String** | | [optional]
24
+ **documents_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the documents. | [optional]
25
+ **email_blurb** | **String** | | [optional]
26
+ **email_settings** | [**EmailSettings**](EmailSettings.md) | | [optional]
27
+ **email_subject** | **String** | Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. | [optional]
28
+ **enable_wet_sign** | **String** | When set to **true**, the signer is allowed to print the document and sign it on paper. | [optional]
29
+ **enforce_signer_visibility** | **String** | When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this. | [optional]
30
+ **envelope_id** | **String** | The envelope ID of the envelope status that failed to post. | [optional]
31
+ **envelope_id_stamping** | **String** | When set to **true**, Envelope ID Stamping is enabled. | [optional]
32
+ **envelope_template_definition** | [**EnvelopeTemplateDefinition**](EnvelopeTemplateDefinition.md) | | [optional]
33
+ **envelope_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. | [optional]
34
+ **initial_sent_date_time** | **String** | | [optional]
35
+ **is21_cfr_part11** | **String** | When set to **true**, indicates that this module is enabled on the account. | [optional]
36
+ **is_signature_provider_envelope** | **String** | | [optional]
37
+ **last_modified_date_time** | **String** | The date and time the item was last modified. | [optional]
38
+ **lock_information** | [**LockInformation**](LockInformation.md) | | [optional]
39
+ **message_lock** | **String** | When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. | [optional]
40
+ **notification** | [**Notification**](Notification.md) | | [optional]
41
+ **notification_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the notifications. | [optional]
42
+ **purge_state** | **String** | | [optional]
43
+ **recipients** | [**Recipients**](Recipients.md) | | [optional]
44
+ **recipients_lock** | **String** | When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. | [optional]
45
+ **recipients_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the recipients. | [optional]
46
+ **sent_date_time** | **String** | The date and time the envelope was sent. | [optional]
47
+ **signing_location** | **String** | Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. | [optional]
48
+ **status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
49
+ **status_changed_date_time** | **String** | The data and time the status changed. | [optional]
50
+ **templates_uri** | **String** | Contains a URI for an endpoint which you can use to retrieve the templates. | [optional]
51
+ **transaction_id** | **String** | Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. | [optional]
52
+ **use_disclosure** | **String** | When set to **true**, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. | [optional]
53
+ **voided_date_time** | **String** | The date and time the envelope or template was voided. | [optional]
54
+ **voided_reason** | **String** | The reason the envelope or template was voided. | [optional]
55
+
56
+
@@ -0,0 +1,22 @@
1
+ # DocuSign_eSign::EnvelopeTemplateDefinition
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **description** | **String** | | [optional]
7
+ **folder_id** | **String** | The ID for the folder. | [optional]
8
+ **folder_name** | **String** | The name of the folder in which the template is located. | [optional]
9
+ **folder_uri** | **String** | The URI of the folder. | [optional]
10
+ **last_modified** | **String** | | [optional]
11
+ **last_modified_by** | [**UserInfo**](UserInfo.md) | | [optional]
12
+ **name** | **String** | | [optional]
13
+ **new_password** | **String** | | [optional]
14
+ **owner** | [**UserInfo**](UserInfo.md) | | [optional]
15
+ **page_count** | **Integer** | An integer value specifying the number of document pages in the template. Omit this property if not submitting a page count. | [optional]
16
+ **parent_folder_uri** | **String** | | [optional]
17
+ **password** | **String** | | [optional]
18
+ **shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
19
+ **template_id** | **String** | The unique identifier of the template. If this is not provided, DocuSign will generate a value. | [optional]
20
+ **uri** | **String** | | [optional]
21
+
22
+
@@ -0,0 +1,68 @@
1
+ # DocuSign_eSign::EnvelopeTemplateResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **allow_markup** | **String** | When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this | [optional]
7
+ **allow_reassign** | **String** | When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. | [optional]
8
+ **asynchronous** | **String** | When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. | [optional]
9
+ **attachments_uri** | **String** | | [optional]
10
+ **authoritative_copy** | **String** | Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. | [optional]
11
+ **auto_navigation** | **String** | | [optional]
12
+ **brand_id** | **String** | | [optional]
13
+ **brand_lock** | **String** | | [optional]
14
+ **certificate_uri** | **String** | Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. | [optional]
15
+ **completed_date_time** | **String** | Specifies the date and time this item was completed. | [optional]
16
+ **created_date_time** | **String** | Indicates the date and time the item was created. | [optional]
17
+ **custom_fields** | [**CustomFields**](CustomFields.md) | | [optional]
18
+ **custom_fields_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the custom fields. | [optional]
19
+ **declined_date_time** | **String** | The date and time the recipient declined the document. | [optional]
20
+ **deleted_date_time** | **String** | Specifies the data and time the item was deleted. | [optional]
21
+ **delivered_date_time** | **String** | Reserved: For DocuSign use only. | [optional]
22
+ **description** | **String** | | [optional]
23
+ **documents** | [**Array<Document>**](Document.md) | Complex element contains the details on the documents in the envelope. | [optional]
24
+ **documents_combined_uri** | **String** | | [optional]
25
+ **documents_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the documents. | [optional]
26
+ **email_blurb** | **String** | | [optional]
27
+ **email_settings** | [**EmailSettings**](EmailSettings.md) | | [optional]
28
+ **email_subject** | **String** | Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. | [optional]
29
+ **enable_wet_sign** | **String** | When set to **true**, the signer is allowed to print the document and sign it on paper. | [optional]
30
+ **enforce_signer_visibility** | **String** | When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this. | [optional]
31
+ **envelope_id** | **String** | The envelope ID of the envelope status that failed to post. | [optional]
32
+ **envelope_id_stamping** | **String** | When set to **true**, Envelope ID Stamping is enabled. | [optional]
33
+ **envelope_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. | [optional]
34
+ **folder_id** | **String** | | [optional]
35
+ **folder_name** | **String** | | [optional]
36
+ **folder_uri** | **String** | | [optional]
37
+ **initial_sent_date_time** | **String** | | [optional]
38
+ **is21_cfr_part11** | **String** | When set to **true**, indicates that this module is enabled on the account. | [optional]
39
+ **is_signature_provider_envelope** | **String** | | [optional]
40
+ **last_modified** | **String** | | [optional]
41
+ **last_modified_date_time** | **String** | The date and time the item was last modified. | [optional]
42
+ **lock_information** | [**LockInformation**](LockInformation.md) | | [optional]
43
+ **message_lock** | **String** | When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. | [optional]
44
+ **name** | **String** | | [optional]
45
+ **notification** | [**Notification**](Notification.md) | | [optional]
46
+ **notification_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the notifications. | [optional]
47
+ **owner** | [**UserInfo**](UserInfo.md) | | [optional]
48
+ **page_count** | **Integer** | | [optional]
49
+ **parent_folder_uri** | **String** | | [optional]
50
+ **password** | **String** | | [optional]
51
+ **purge_state** | **String** | | [optional]
52
+ **recipients** | [**Recipients**](Recipients.md) | | [optional]
53
+ **recipients_lock** | **String** | When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. | [optional]
54
+ **recipients_uri** | **String** | Contains a URI for an endpoint that you can use to retrieve the recipients. | [optional]
55
+ **sent_date_time** | **String** | The date and time the envelope was sent. | [optional]
56
+ **shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
57
+ **signing_location** | **String** | Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. | [optional]
58
+ **status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
59
+ **status_changed_date_time** | **String** | The data and time the status changed. | [optional]
60
+ **template_id** | **String** | The unique identifier of the template. If this is not provided, DocuSign will generate a value. | [optional]
61
+ **templates_uri** | **String** | Contains a URI for an endpoint which you can use to retrieve the templates. | [optional]
62
+ **transaction_id** | **String** | Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. | [optional]
63
+ **uri** | **String** | | [optional]
64
+ **use_disclosure** | **String** | When set to **true**, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. | [optional]
65
+ **voided_date_time** | **String** | The date and time the envelope or template was voided. | [optional]
66
+ **voided_reason** | **String** | The reason the envelope or template was voided. | [optional]
67
+
68
+
@@ -0,0 +1,15 @@
1
+ # DocuSign_eSign::EnvelopeTemplateResults
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **end_position** | **String** | The last position in the result set. | [optional]
7
+ **envelope_templates** | [**Array<EnvelopeTemplateResult>**](EnvelopeTemplateResult.md) | The list of requested templates. | [optional]
8
+ **folders** | [**Array<Folder>**](Folder.md) | | [optional]
9
+ **next_uri** | **String** | The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. | [optional]
10
+ **previous_uri** | **String** | The postal code for the billing address. | [optional]
11
+ **result_set_size** | **String** | The number of results returned in this response. | [optional]
12
+ **start_position** | **String** | Starting position of the current result set. | [optional]
13
+ **total_set_size** | **String** | The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. | [optional]
14
+
15
+
@@ -0,0 +1,11 @@
1
+ # DocuSign_eSign::EnvelopeTransactionStatus
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **envelope_id** | **String** | The envelope ID of the envelope status that failed to post. | [optional]
7
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
8
+ **status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
9
+ **transaction_id** | **String** | Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. | [optional]
10
+
11
+
@@ -0,0 +1,15 @@
1
+ # DocuSign_eSign::EnvelopeUpdateSummary
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **bulk_envelope_status** | [**BulkEnvelopeStatus**](BulkEnvelopeStatus.md) | | [optional]
7
+ **envelope_id** | **String** | The envelope ID of the envelope status that failed to post. | [optional]
8
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
9
+ **list_custom_field_update_results** | [**Array<ListCustomField>**](ListCustomField.md) | | [optional]
10
+ **lock_information** | [**LockInformation**](LockInformation.md) | | [optional]
11
+ **recipient_update_results** | [**Array<RecipientUpdateResponse>**](RecipientUpdateResponse.md) | | [optional]
12
+ **tab_update_results** | [**Tabs**](Tabs.md) | | [optional]
13
+ **text_custom_field_update_results** | [**Array<TextCustomField>**](TextCustomField.md) | | [optional]
14
+
15
+
@@ -0,0 +1,4306 @@
1
+ # DocuSign_eSign::EnvelopesApi
2
+
3
+ All URIs are relative to *https://www.docusign.net/restapi*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**apply_template**](EnvelopesApi.md#apply_template) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/templates | Adds templates to an envelope.
8
+ [**apply_template_to_document**](EnvelopesApi.md#apply_template_to_document) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates | Adds templates to a document in an envelope.
9
+ [**create_chunked_upload**](EnvelopesApi.md#create_chunked_upload) | **POST** /v2/accounts/{accountId}/chunked_uploads | Initiate a new ChunkedUpload.
10
+ [**create_console_view**](EnvelopesApi.md#create_console_view) | **POST** /v2/accounts/{accountId}/views/console | Returns a URL to the authentication view UI.
11
+ [**create_correct_view**](EnvelopesApi.md#create_correct_view) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/views/correct | Returns a URL to the envelope correction UI.
12
+ [**create_custom_fields**](EnvelopesApi.md#create_custom_fields) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields | Updates envelope custom fields for an envelope.
13
+ [**create_document_fields**](EnvelopesApi.md#create_document_fields) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields | Creates custom document fields in an existing envelope document.
14
+ [**create_edit_view**](EnvelopesApi.md#create_edit_view) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/views/edit | Returns a URL to the edit view UI.
15
+ [**create_email_settings**](EnvelopesApi.md#create_email_settings) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings | Adds email setting overrides to an envelope.
16
+ [**create_envelope**](EnvelopesApi.md#create_envelope) | **POST** /v2/accounts/{accountId}/envelopes | Creates an envelope.
17
+ [**create_lock**](EnvelopesApi.md#create_lock) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/lock | Lock an envelope.
18
+ [**create_recipient**](EnvelopesApi.md#create_recipient) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients | Adds one or more recipients to an envelope.
19
+ [**create_recipient_view**](EnvelopesApi.md#create_recipient_view) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/views/recipient | Returns a URL to the recipient view UI.
20
+ [**create_sender_view**](EnvelopesApi.md#create_sender_view) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/views/sender | Returns a URL to the sender view UI.
21
+ [**create_tabs**](EnvelopesApi.md#create_tabs) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs | Adds tabs for a recipient.
22
+ [**create_view_link**](EnvelopesApi.md#create_view_link) | **POST** /v2/accounts/{accountId}/envelopes/{envelopeId}/views/viewlink | Reserved: Returns a URL to the secure link view UI.
23
+ [**delete_attachments**](EnvelopesApi.md#delete_attachments) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments | Delete one or more attachments from a DRAFT envelope.
24
+ [**delete_chunked_upload**](EnvelopesApi.md#delete_chunked_upload) | **DELETE** /v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId} | Delete an existing ChunkedUpload.
25
+ [**delete_custom_fields**](EnvelopesApi.md#delete_custom_fields) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields | Deletes envelope custom fields for draft and in-process envelopes.
26
+ [**delete_document_fields**](EnvelopesApi.md#delete_document_fields) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields | Deletes custom document fields from an existing envelope document.
27
+ [**delete_document_page**](EnvelopesApi.md#delete_document_page) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber} | Deletes a page from a document in an envelope.
28
+ [**delete_documents**](EnvelopesApi.md#delete_documents) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents | Deletes documents from a draft envelope.
29
+ [**delete_email_settings**](EnvelopesApi.md#delete_email_settings) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings | Deletes the email setting overrides for an envelope.
30
+ [**delete_lock**](EnvelopesApi.md#delete_lock) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/lock | Deletes an envelope lock.
31
+ [**delete_recipient**](EnvelopesApi.md#delete_recipient) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId} | Deletes a recipient from an envelope.
32
+ [**delete_recipients**](EnvelopesApi.md#delete_recipients) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients | Deletes recipients from an envelope.
33
+ [**delete_tabs**](EnvelopesApi.md#delete_tabs) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs | Deletes the tabs associated with a recipient.
34
+ [**delete_templates_from_document**](EnvelopesApi.md#delete_templates_from_document) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId} | Deletes a template from a document in an existing envelope.
35
+ [**delete_view_link**](EnvelopesApi.md#delete_view_link) | **DELETE** /v2/accounts/{accountId}/envelopes/{envelopeId}/views/viewlink | Reserved: Expires a secure view link.
36
+ [**get_attachment**](EnvelopesApi.md#get_attachment) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId} | Retrieves an attachment from the envelope.
37
+ [**get_attachments**](EnvelopesApi.md#get_attachments) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments | Returns a list of attachments associated with the specified envelope
38
+ [**get_chunked_upload**](EnvelopesApi.md#get_chunked_upload) | **GET** /v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId} | Retrieves the current metadata of a ChunkedUpload.
39
+ [**get_consumer_disclosure**](EnvelopesApi.md#get_consumer_disclosure) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode} | Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
40
+ [**get_consumer_disclosure_default**](EnvelopesApi.md#get_consumer_disclosure_default) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure | Gets the Electronic Record and Signature Disclosure associated with the account.
41
+ [**get_document**](EnvelopesApi.md#get_document) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId} | Gets a document from an envelope.
42
+ [**get_document_page_image**](EnvelopesApi.md#get_document_page_image) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image | Gets a page image from an envelope for display.
43
+ [**get_email_settings**](EnvelopesApi.md#get_email_settings) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings | Gets the email setting overrides for an envelope.
44
+ [**get_envelope**](EnvelopesApi.md#get_envelope) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId} | Gets the status of a envelope.
45
+ [**get_form_data**](EnvelopesApi.md#get_form_data) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/form_data | Returns envelope form data for an existing envelope.
46
+ [**get_lock**](EnvelopesApi.md#get_lock) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/lock | Gets envelope lock information.
47
+ [**get_notification_settings**](EnvelopesApi.md#get_notification_settings) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/notification | Gets envelope notification information.
48
+ [**get_recipient_document_visibility**](EnvelopesApi.md#get_recipient_document_visibility) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility | Returns document visibility for the recipients
49
+ [**get_recipient_initials_image**](EnvelopesApi.md#get_recipient_initials_image) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image | Gets the initials image for a user.
50
+ [**get_recipient_signature**](EnvelopesApi.md#get_recipient_signature) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature | Gets signature information for a signer or sign-in-person recipient.
51
+ [**get_recipient_signature_image**](EnvelopesApi.md#get_recipient_signature_image) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image | Retrieve signature image information for a signer/sign-in-person recipient.
52
+ [**get_template_recipient_document_visibility**](EnvelopesApi.md#get_template_recipient_document_visibility) | **GET** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility | Returns document visibility for the recipients
53
+ [**list_audit_events**](EnvelopesApi.md#list_audit_events) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/audit_events | Gets the envelope audit events for an envelope.
54
+ [**list_custom_fields**](EnvelopesApi.md#list_custom_fields) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields | Gets the custom field information for the specified envelope.
55
+ [**list_document_fields**](EnvelopesApi.md#list_document_fields) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields | Gets the custom document fields from an existing envelope document.
56
+ [**list_documents**](EnvelopesApi.md#list_documents) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents | Gets a list of envelope documents.
57
+ [**list_recipients**](EnvelopesApi.md#list_recipients) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients | Gets the status of recipients for an envelope.
58
+ [**list_status**](EnvelopesApi.md#list_status) | **PUT** /v2/accounts/{accountId}/envelopes/status | Gets the envelope status for the specified envelopes.
59
+ [**list_status_changes**](EnvelopesApi.md#list_status_changes) | **GET** /v2/accounts/{accountId}/envelopes | Gets status changes for one or more envelopes.
60
+ [**list_tabs**](EnvelopesApi.md#list_tabs) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs | Gets the tabs information for a signer or sign-in-person recipient in an envelope.
61
+ [**list_templates**](EnvelopesApi.md#list_templates) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/templates | Get List of Templates used in an Envelope
62
+ [**list_templates_for_document**](EnvelopesApi.md#list_templates_for_document) | **GET** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates | Gets the templates associated with a document in an existing envelope.
63
+ [**put_attachment**](EnvelopesApi.md#put_attachment) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId} | Add an attachment to a DRAFT or IN-PROCESS envelope.
64
+ [**put_attachments**](EnvelopesApi.md#put_attachments) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments | Add one or more attachments to a DRAFT or IN-PROCESS envelope.
65
+ [**rotate_document_page**](EnvelopesApi.md#rotate_document_page) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image | Rotates page image from an envelope for display.
66
+ [**update**](EnvelopesApi.md#update) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId} | Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft
67
+ [**update_chunked_upload**](EnvelopesApi.md#update_chunked_upload) | **PUT** /v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId} | Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
68
+ [**update_chunked_upload_part**](EnvelopesApi.md#update_chunked_upload_part) | **PUT** /v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq} | Add a chunk, a chunk 'part', to an existing ChunkedUpload.
69
+ [**update_custom_fields**](EnvelopesApi.md#update_custom_fields) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields | Updates envelope custom fields in an envelope.
70
+ [**update_document**](EnvelopesApi.md#update_document) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId} | Adds a document to an existing draft envelope.
71
+ [**update_document_fields**](EnvelopesApi.md#update_document_fields) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields | Updates existing custom document fields in an existing envelope document.
72
+ [**update_documents**](EnvelopesApi.md#update_documents) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/documents | Adds one or more documents to an existing envelope document.
73
+ [**update_email_settings**](EnvelopesApi.md#update_email_settings) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings | Updates the email setting overrides for an envelope.
74
+ [**update_lock**](EnvelopesApi.md#update_lock) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/lock | Updates an envelope lock.
75
+ [**update_notification_settings**](EnvelopesApi.md#update_notification_settings) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/notification | Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
76
+ [**update_recipient_document_visibility**](EnvelopesApi.md#update_recipient_document_visibility) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility | Updates document visibility for the recipients
77
+ [**update_recipient_initials_image**](EnvelopesApi.md#update_recipient_initials_image) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image | Sets the initials image for an accountless signer.
78
+ [**update_recipient_signature_image**](EnvelopesApi.md#update_recipient_signature_image) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image | Sets the signature image for an accountless signer.
79
+ [**update_recipients**](EnvelopesApi.md#update_recipients) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients | Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
80
+ [**update_recipients_document_visibility**](EnvelopesApi.md#update_recipients_document_visibility) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility | Updates document visibility for the recipients
81
+ [**update_tabs**](EnvelopesApi.md#update_tabs) | **PUT** /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs | Updates the tabs for a recipient.
82
+ [**update_template_recipient_document_visibility**](EnvelopesApi.md#update_template_recipient_document_visibility) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility | Updates document visibility for the recipients
83
+ [**update_template_recipients_document_visibility**](EnvelopesApi.md#update_template_recipients_document_visibility) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/recipients/document_visibility | Updates document visibility for the recipients
84
+
85
+
86
+ # **apply_template**
87
+ > DocumentTemplateList apply_template(account_id, envelope_id, opts)
88
+
89
+ Adds templates to an envelope.
90
+
91
+ Adds templates to the specified envelope.
92
+
93
+ ### Example
94
+ ```ruby
95
+ # load the gem
96
+ require 'docusign_esign'
97
+
98
+ api_instance = DocuSign_eSign::EnvelopesApi.new
99
+
100
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
101
+
102
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
103
+
104
+ opts = {
105
+ document_template_list: DocuSign_eSign::DocumentTemplateList.new # DocumentTemplateList |
106
+ }
107
+
108
+ begin
109
+ #Adds templates to an envelope.
110
+ result = api_instance.apply_template(account_id, envelope_id, opts)
111
+ p result
112
+ rescue DocuSign_eSign::ApiError => e
113
+ puts "Exception when calling EnvelopesApi->apply_template: #{e}"
114
+ end
115
+ ```
116
+
117
+ ### Parameters
118
+
119
+ Name | Type | Description | Notes
120
+ ------------- | ------------- | ------------- | -------------
121
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
122
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
123
+ **document_template_list** | [**DocumentTemplateList**](DocumentTemplateList.md)| | [optional]
124
+
125
+ ### Return type
126
+
127
+ [**DocumentTemplateList**](DocumentTemplateList.md)
128
+
129
+ ### Authorization
130
+
131
+ No authorization required
132
+
133
+ ### HTTP request headers
134
+
135
+ - **Content-Type**: Not defined
136
+ - **Accept**: application/json
137
+
138
+
139
+
140
+ # **apply_template_to_document**
141
+ > DocumentTemplateList apply_template_to_document(account_id, document_id, envelope_id, opts)
142
+
143
+ Adds templates to a document in an envelope.
144
+
145
+ Adds templates to a document in the specified envelope.
146
+
147
+ ### Example
148
+ ```ruby
149
+ # load the gem
150
+ require 'docusign_esign'
151
+
152
+ api_instance = DocuSign_eSign::EnvelopesApi.new
153
+
154
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
155
+
156
+ document_id = "document_id_example" # String | The ID of the document being accessed.
157
+
158
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
159
+
160
+ opts = {
161
+ document_template_list: DocuSign_eSign::DocumentTemplateList.new # DocumentTemplateList |
162
+ }
163
+
164
+ begin
165
+ #Adds templates to a document in an envelope.
166
+ result = api_instance.apply_template_to_document(account_id, document_id, envelope_id, opts)
167
+ p result
168
+ rescue DocuSign_eSign::ApiError => e
169
+ puts "Exception when calling EnvelopesApi->apply_template_to_document: #{e}"
170
+ end
171
+ ```
172
+
173
+ ### Parameters
174
+
175
+ Name | Type | Description | Notes
176
+ ------------- | ------------- | ------------- | -------------
177
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
178
+ **document_id** | **String**| The ID of the document being accessed. |
179
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
180
+ **document_template_list** | [**DocumentTemplateList**](DocumentTemplateList.md)| | [optional]
181
+
182
+ ### Return type
183
+
184
+ [**DocumentTemplateList**](DocumentTemplateList.md)
185
+
186
+ ### Authorization
187
+
188
+ No authorization required
189
+
190
+ ### HTTP request headers
191
+
192
+ - **Content-Type**: Not defined
193
+ - **Accept**: application/json
194
+
195
+
196
+
197
+ # **create_chunked_upload**
198
+ > ChunkedUploadResponse create_chunked_upload(account_id, opts)
199
+
200
+ Initiate a new ChunkedUpload.
201
+
202
+ ### Example
203
+ ```ruby
204
+ # load the gem
205
+ require 'docusign_esign'
206
+
207
+ api_instance = DocuSign_eSign::EnvelopesApi.new
208
+
209
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
210
+
211
+ opts = {
212
+ chunked_upload_request: DocuSign_eSign::ChunkedUploadRequest.new # ChunkedUploadRequest |
213
+ }
214
+
215
+ begin
216
+ #Initiate a new ChunkedUpload.
217
+ result = api_instance.create_chunked_upload(account_id, opts)
218
+ p result
219
+ rescue DocuSign_eSign::ApiError => e
220
+ puts "Exception when calling EnvelopesApi->create_chunked_upload: #{e}"
221
+ end
222
+ ```
223
+
224
+ ### Parameters
225
+
226
+ Name | Type | Description | Notes
227
+ ------------- | ------------- | ------------- | -------------
228
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
229
+ **chunked_upload_request** | [**ChunkedUploadRequest**](ChunkedUploadRequest.md)| | [optional]
230
+
231
+ ### Return type
232
+
233
+ [**ChunkedUploadResponse**](ChunkedUploadResponse.md)
234
+
235
+ ### Authorization
236
+
237
+ No authorization required
238
+
239
+ ### HTTP request headers
240
+
241
+ - **Content-Type**: Not defined
242
+ - **Accept**: application/json
243
+
244
+
245
+
246
+ # **create_console_view**
247
+ > ViewUrl create_console_view(account_id, opts)
248
+
249
+ Returns a URL to the authentication view UI.
250
+
251
+ Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
252
+
253
+ ### Example
254
+ ```ruby
255
+ # load the gem
256
+ require 'docusign_esign'
257
+
258
+ api_instance = DocuSign_eSign::EnvelopesApi.new
259
+
260
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
261
+
262
+ opts = {
263
+ console_view_request: DocuSign_eSign::ConsoleViewRequest.new # ConsoleViewRequest |
264
+ }
265
+
266
+ begin
267
+ #Returns a URL to the authentication view UI.
268
+ result = api_instance.create_console_view(account_id, opts)
269
+ p result
270
+ rescue DocuSign_eSign::ApiError => e
271
+ puts "Exception when calling EnvelopesApi->create_console_view: #{e}"
272
+ end
273
+ ```
274
+
275
+ ### Parameters
276
+
277
+ Name | Type | Description | Notes
278
+ ------------- | ------------- | ------------- | -------------
279
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
280
+ **console_view_request** | [**ConsoleViewRequest**](ConsoleViewRequest.md)| | [optional]
281
+
282
+ ### Return type
283
+
284
+ [**ViewUrl**](ViewUrl.md)
285
+
286
+ ### Authorization
287
+
288
+ No authorization required
289
+
290
+ ### HTTP request headers
291
+
292
+ - **Content-Type**: Not defined
293
+ - **Accept**: application/json
294
+
295
+
296
+
297
+ # **create_correct_view**
298
+ > ViewUrl create_correct_view(account_id, envelope_id, opts)
299
+
300
+ Returns a URL to the envelope correction UI.
301
+
302
+ Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
303
+
304
+ ### Example
305
+ ```ruby
306
+ # load the gem
307
+ require 'docusign_esign'
308
+
309
+ api_instance = DocuSign_eSign::EnvelopesApi.new
310
+
311
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
312
+
313
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
314
+
315
+ opts = {
316
+ correct_view_request: DocuSign_eSign::CorrectViewRequest.new # CorrectViewRequest |
317
+ }
318
+
319
+ begin
320
+ #Returns a URL to the envelope correction UI.
321
+ result = api_instance.create_correct_view(account_id, envelope_id, opts)
322
+ p result
323
+ rescue DocuSign_eSign::ApiError => e
324
+ puts "Exception when calling EnvelopesApi->create_correct_view: #{e}"
325
+ end
326
+ ```
327
+
328
+ ### Parameters
329
+
330
+ Name | Type | Description | Notes
331
+ ------------- | ------------- | ------------- | -------------
332
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
333
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
334
+ **correct_view_request** | [**CorrectViewRequest**](CorrectViewRequest.md)| | [optional]
335
+
336
+ ### Return type
337
+
338
+ [**ViewUrl**](ViewUrl.md)
339
+
340
+ ### Authorization
341
+
342
+ No authorization required
343
+
344
+ ### HTTP request headers
345
+
346
+ - **Content-Type**: Not defined
347
+ - **Accept**: application/json
348
+
349
+
350
+
351
+ # **create_custom_fields**
352
+ > CustomFields create_custom_fields(account_id, envelope_id, opts)
353
+
354
+ Updates envelope custom fields for an envelope.
355
+
356
+ Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
357
+
358
+ ### Example
359
+ ```ruby
360
+ # load the gem
361
+ require 'docusign_esign'
362
+
363
+ api_instance = DocuSign_eSign::EnvelopesApi.new
364
+
365
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
366
+
367
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
368
+
369
+ opts = {
370
+ custom_fields: DocuSign_eSign::CustomFields.new # CustomFields |
371
+ }
372
+
373
+ begin
374
+ #Updates envelope custom fields for an envelope.
375
+ result = api_instance.create_custom_fields(account_id, envelope_id, opts)
376
+ p result
377
+ rescue DocuSign_eSign::ApiError => e
378
+ puts "Exception when calling EnvelopesApi->create_custom_fields: #{e}"
379
+ end
380
+ ```
381
+
382
+ ### Parameters
383
+
384
+ Name | Type | Description | Notes
385
+ ------------- | ------------- | ------------- | -------------
386
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
387
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
388
+ **custom_fields** | [**CustomFields**](CustomFields.md)| | [optional]
389
+
390
+ ### Return type
391
+
392
+ [**CustomFields**](CustomFields.md)
393
+
394
+ ### Authorization
395
+
396
+ No authorization required
397
+
398
+ ### HTTP request headers
399
+
400
+ - **Content-Type**: Not defined
401
+ - **Accept**: application/json
402
+
403
+
404
+
405
+ # **create_document_fields**
406
+ > DocumentFieldsInformation create_document_fields(account_id, document_id, envelope_id, opts)
407
+
408
+ Creates custom document fields in an existing envelope document.
409
+
410
+ Creates custom document fields in an existing envelope document.
411
+
412
+ ### Example
413
+ ```ruby
414
+ # load the gem
415
+ require 'docusign_esign'
416
+
417
+ api_instance = DocuSign_eSign::EnvelopesApi.new
418
+
419
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
420
+
421
+ document_id = "document_id_example" # String | The ID of the document being accessed.
422
+
423
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
424
+
425
+ opts = {
426
+ document_fields_information: DocuSign_eSign::DocumentFieldsInformation.new # DocumentFieldsInformation |
427
+ }
428
+
429
+ begin
430
+ #Creates custom document fields in an existing envelope document.
431
+ result = api_instance.create_document_fields(account_id, document_id, envelope_id, opts)
432
+ p result
433
+ rescue DocuSign_eSign::ApiError => e
434
+ puts "Exception when calling EnvelopesApi->create_document_fields: #{e}"
435
+ end
436
+ ```
437
+
438
+ ### Parameters
439
+
440
+ Name | Type | Description | Notes
441
+ ------------- | ------------- | ------------- | -------------
442
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
443
+ **document_id** | **String**| The ID of the document being accessed. |
444
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
445
+ **document_fields_information** | [**DocumentFieldsInformation**](DocumentFieldsInformation.md)| | [optional]
446
+
447
+ ### Return type
448
+
449
+ [**DocumentFieldsInformation**](DocumentFieldsInformation.md)
450
+
451
+ ### Authorization
452
+
453
+ No authorization required
454
+
455
+ ### HTTP request headers
456
+
457
+ - **Content-Type**: Not defined
458
+ - **Accept**: application/json
459
+
460
+
461
+
462
+ # **create_edit_view**
463
+ > ViewUrl create_edit_view(account_id, envelope_id, opts)
464
+
465
+ Returns a URL to the edit view UI.
466
+
467
+ Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
468
+
469
+ ### Example
470
+ ```ruby
471
+ # load the gem
472
+ require 'docusign_esign'
473
+
474
+ api_instance = DocuSign_eSign::EnvelopesApi.new
475
+
476
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
477
+
478
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
479
+
480
+ opts = {
481
+ return_url_request: DocuSign_eSign::ReturnUrlRequest.new # ReturnUrlRequest |
482
+ }
483
+
484
+ begin
485
+ #Returns a URL to the edit view UI.
486
+ result = api_instance.create_edit_view(account_id, envelope_id, opts)
487
+ p result
488
+ rescue DocuSign_eSign::ApiError => e
489
+ puts "Exception when calling EnvelopesApi->create_edit_view: #{e}"
490
+ end
491
+ ```
492
+
493
+ ### Parameters
494
+
495
+ Name | Type | Description | Notes
496
+ ------------- | ------------- | ------------- | -------------
497
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
498
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
499
+ **return_url_request** | [**ReturnUrlRequest**](ReturnUrlRequest.md)| | [optional]
500
+
501
+ ### Return type
502
+
503
+ [**ViewUrl**](ViewUrl.md)
504
+
505
+ ### Authorization
506
+
507
+ No authorization required
508
+
509
+ ### HTTP request headers
510
+
511
+ - **Content-Type**: Not defined
512
+ - **Accept**: application/json
513
+
514
+
515
+
516
+ # **create_email_settings**
517
+ > EmailSettings create_email_settings(account_id, envelope_id, opts)
518
+
519
+ Adds email setting overrides to an envelope.
520
+
521
+ Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
522
+
523
+ ### Example
524
+ ```ruby
525
+ # load the gem
526
+ require 'docusign_esign'
527
+
528
+ api_instance = DocuSign_eSign::EnvelopesApi.new
529
+
530
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
531
+
532
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
533
+
534
+ opts = {
535
+ email_settings: DocuSign_eSign::EmailSettings.new # EmailSettings |
536
+ }
537
+
538
+ begin
539
+ #Adds email setting overrides to an envelope.
540
+ result = api_instance.create_email_settings(account_id, envelope_id, opts)
541
+ p result
542
+ rescue DocuSign_eSign::ApiError => e
543
+ puts "Exception when calling EnvelopesApi->create_email_settings: #{e}"
544
+ end
545
+ ```
546
+
547
+ ### Parameters
548
+
549
+ Name | Type | Description | Notes
550
+ ------------- | ------------- | ------------- | -------------
551
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
552
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
553
+ **email_settings** | [**EmailSettings**](EmailSettings.md)| | [optional]
554
+
555
+ ### Return type
556
+
557
+ [**EmailSettings**](EmailSettings.md)
558
+
559
+ ### Authorization
560
+
561
+ No authorization required
562
+
563
+ ### HTTP request headers
564
+
565
+ - **Content-Type**: Not defined
566
+ - **Accept**: application/json
567
+
568
+
569
+
570
+ # **create_envelope**
571
+ > EnvelopeSummary create_envelope(account_id, opts)
572
+
573
+ Creates an envelope.
574
+
575
+ Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request’s `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the [`document` object](#/definitions/document) ### Recipient Types An [`envelopeDefinition` object](#/definitions/envelopeDefinition) is used as the method’s body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object’s `recipients` field is an [`EnvelopeRecipients` resource object](#/definitions/EnvelopeRecipients). It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition -------------- | ----------------- agent (can add name and email information for later recipients/signers) | [`agent`](#/definitions/agent) carbon copy (receives a copy of the documents) | [`carbonCopy`](#/definitions/carbonCopy) certified delivery (receives a copy of the documents and must acknowledge receipt) | [`certifiedDelivery`](#/definitions/certifiedDelivery) editor (can change recipients and document fields for later recipients/signers) | [`editor`](#/definitions/editor) in-person signer (“hosts” someone who signs in-person) | [`inPersonSigner`](#/definitions/inPersonSigner) intermediary (can add name and email information for some later recipients/signers.) | [`intermediary`](#/definitions/intermediary) signer (signs and/or updates document fields) | [`signer`](#/definitions/signer) Additional information about the different types of recipients is available from the [`EnvelopeRecipients` resource page](../../EnvelopeRecipients) and from the [Developer Center](https://www.docusign.com/developer-center/explore/features/recipients) ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an [`EnvelopeTabs` resource object](#/definitions/EnvelopeTabs). It includes arrays of the 24 different tab types available. See the [`EnvelopeTabs` resource](../../EnvelopeTabs) for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the [`EnvelopeRecipients` object](#/definitions/EnvelopeRecipients) are used to assign recipients to the template’s roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` **true**, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope’s status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the [Webhook recipe](https://www.docusign.com/developer-center/recipes/webhook-status) for examples and live demos of using webhooks. ## Webhook Options The two webhook options, *eventNotification* and *Connect* use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional [eventNotification object](#definition-eventNotification) that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the [ConnectConfigurations resource](../../Connect/ConnectConfigurations). Configurations can also be created and managed from the Administration tool accessed by selecting “Go to Admin” from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like [compositing in film production](https://en.wikipedia.org/wiki/Compositing), enables you to *overlay* document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the *first* document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to \"true\" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template’s `document` field, the *first* template’s document (based on the template’s Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with “\\*” and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` --5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename=\"eula.pdf\"; documentId=1; compositeTemplateId=\"1\" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a *PDF Form Digital Signature Field,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ------- | -------- DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming *PDF Form Text Fields,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ------- | -------- DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include “DocuSignIgnoreTransform” or “eSignIgnoreTransform” will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert 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 `roleName`, are added to the `emailSubject` 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. 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` 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 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 `roleName` 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. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account’s default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account’s default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don’t use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
576
+
577
+ ### Example
578
+ ```ruby
579
+ # load the gem
580
+ require 'docusign_esign'
581
+
582
+ api_instance = DocuSign_eSign::EnvelopesApi.new
583
+
584
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
585
+
586
+ opts = {
587
+ cdse_mode: "cdse_mode_example", # String |
588
+ completed_documents_only: "completed_documents_only_example", # String | If set to true then we want to set the sourceEnvelopeId to indicate that this is a\"forward\" envelope action
589
+ merge_roles_on_draft: "merge_roles_on_draft_example", # String | When set to **true**, merges template roles and remove empty recipients when you create an envelope with multiple templates.
590
+ envelope_definition: DocuSign_eSign::EnvelopeDefinition.new # EnvelopeDefinition |
591
+ }
592
+
593
+ begin
594
+ #Creates an envelope.
595
+ result = api_instance.create_envelope(account_id, opts)
596
+ p result
597
+ rescue DocuSign_eSign::ApiError => e
598
+ puts "Exception when calling EnvelopesApi->create_envelope: #{e}"
599
+ end
600
+ ```
601
+
602
+ ### Parameters
603
+
604
+ Name | Type | Description | Notes
605
+ ------------- | ------------- | ------------- | -------------
606
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
607
+ **cdse_mode** | **String**| | [optional]
608
+ **completed_documents_only** | **String**| If set to true then we want to set the sourceEnvelopeId to indicate that this is a\&quot;forward\&quot; envelope action | [optional]
609
+ **merge_roles_on_draft** | **String**| When set to **true**, merges template roles and remove empty recipients when you create an envelope with multiple templates. | [optional]
610
+ **envelope_definition** | [**EnvelopeDefinition**](EnvelopeDefinition.md)| | [optional]
611
+
612
+ ### Return type
613
+
614
+ [**EnvelopeSummary**](EnvelopeSummary.md)
615
+
616
+ ### Authorization
617
+
618
+ No authorization required
619
+
620
+ ### HTTP request headers
621
+
622
+ - **Content-Type**: Not defined
623
+ - **Accept**: application/json
624
+
625
+
626
+
627
+ # **create_lock**
628
+ > LockInformation create_lock(account_id, envelope_id, opts)
629
+
630
+ Lock an envelope.
631
+
632
+ Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
633
+
634
+ ### Example
635
+ ```ruby
636
+ # load the gem
637
+ require 'docusign_esign'
638
+
639
+ api_instance = DocuSign_eSign::EnvelopesApi.new
640
+
641
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
642
+
643
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
644
+
645
+ opts = {
646
+ lock_request: DocuSign_eSign::LockRequest.new # LockRequest |
647
+ }
648
+
649
+ begin
650
+ #Lock an envelope.
651
+ result = api_instance.create_lock(account_id, envelope_id, opts)
652
+ p result
653
+ rescue DocuSign_eSign::ApiError => e
654
+ puts "Exception when calling EnvelopesApi->create_lock: #{e}"
655
+ end
656
+ ```
657
+
658
+ ### Parameters
659
+
660
+ Name | Type | Description | Notes
661
+ ------------- | ------------- | ------------- | -------------
662
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
663
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
664
+ **lock_request** | [**LockRequest**](LockRequest.md)| | [optional]
665
+
666
+ ### Return type
667
+
668
+ [**LockInformation**](LockInformation.md)
669
+
670
+ ### Authorization
671
+
672
+ No authorization required
673
+
674
+ ### HTTP request headers
675
+
676
+ - **Content-Type**: Not defined
677
+ - **Accept**: application/json
678
+
679
+
680
+
681
+ # **create_recipient**
682
+ > Recipients create_recipient(account_id, envelope_id, opts)
683
+
684
+ Adds one or more recipients to an envelope.
685
+
686
+ Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
687
+
688
+ ### Example
689
+ ```ruby
690
+ # load the gem
691
+ require 'docusign_esign'
692
+
693
+ api_instance = DocuSign_eSign::EnvelopesApi.new
694
+
695
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
696
+
697
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
698
+
699
+ opts = {
700
+ resend_envelope: "resend_envelope_example", # String | When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope’s next recipient.
701
+ recipients: DocuSign_eSign::Recipients.new # Recipients |
702
+ }
703
+
704
+ begin
705
+ #Adds one or more recipients to an envelope.
706
+ result = api_instance.create_recipient(account_id, envelope_id, opts)
707
+ p result
708
+ rescue DocuSign_eSign::ApiError => e
709
+ puts "Exception when calling EnvelopesApi->create_recipient: #{e}"
710
+ end
711
+ ```
712
+
713
+ ### Parameters
714
+
715
+ Name | Type | Description | Notes
716
+ ------------- | ------------- | ------------- | -------------
717
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
718
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
719
+ **resend_envelope** | **String**| When set to **true**, resends the envelope if the new recipient&#39;s routing order is before or the same as the envelope’s next recipient. | [optional]
720
+ **recipients** | [**Recipients**](Recipients.md)| | [optional]
721
+
722
+ ### Return type
723
+
724
+ [**Recipients**](Recipients.md)
725
+
726
+ ### Authorization
727
+
728
+ No authorization required
729
+
730
+ ### HTTP request headers
731
+
732
+ - **Content-Type**: Not defined
733
+ - **Accept**: application/json
734
+
735
+
736
+
737
+ # **create_recipient_view**
738
+ > ViewUrl create_recipient_view(account_id, envelope_id, opts)
739
+
740
+ Returns a URL to the recipient view UI.
741
+
742
+ Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
743
+
744
+ ### Example
745
+ ```ruby
746
+ # load the gem
747
+ require 'docusign_esign'
748
+
749
+ api_instance = DocuSign_eSign::EnvelopesApi.new
750
+
751
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
752
+
753
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
754
+
755
+ opts = {
756
+ recipient_view_request: DocuSign_eSign::RecipientViewRequest.new # RecipientViewRequest |
757
+ }
758
+
759
+ begin
760
+ #Returns a URL to the recipient view UI.
761
+ result = api_instance.create_recipient_view(account_id, envelope_id, opts)
762
+ p result
763
+ rescue DocuSign_eSign::ApiError => e
764
+ puts "Exception when calling EnvelopesApi->create_recipient_view: #{e}"
765
+ end
766
+ ```
767
+
768
+ ### Parameters
769
+
770
+ Name | Type | Description | Notes
771
+ ------------- | ------------- | ------------- | -------------
772
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
773
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
774
+ **recipient_view_request** | [**RecipientViewRequest**](RecipientViewRequest.md)| | [optional]
775
+
776
+ ### Return type
777
+
778
+ [**ViewUrl**](ViewUrl.md)
779
+
780
+ ### Authorization
781
+
782
+ No authorization required
783
+
784
+ ### HTTP request headers
785
+
786
+ - **Content-Type**: Not defined
787
+ - **Accept**: application/json
788
+
789
+
790
+
791
+ # **create_sender_view**
792
+ > ViewUrl create_sender_view(account_id, envelope_id, opts)
793
+
794
+ Returns a URL to the sender view UI.
795
+
796
+ Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
797
+
798
+ ### Example
799
+ ```ruby
800
+ # load the gem
801
+ require 'docusign_esign'
802
+
803
+ api_instance = DocuSign_eSign::EnvelopesApi.new
804
+
805
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
806
+
807
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
808
+
809
+ opts = {
810
+ return_url_request: DocuSign_eSign::ReturnUrlRequest.new # ReturnUrlRequest |
811
+ }
812
+
813
+ begin
814
+ #Returns a URL to the sender view UI.
815
+ result = api_instance.create_sender_view(account_id, envelope_id, opts)
816
+ p result
817
+ rescue DocuSign_eSign::ApiError => e
818
+ puts "Exception when calling EnvelopesApi->create_sender_view: #{e}"
819
+ end
820
+ ```
821
+
822
+ ### Parameters
823
+
824
+ Name | Type | Description | Notes
825
+ ------------- | ------------- | ------------- | -------------
826
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
827
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
828
+ **return_url_request** | [**ReturnUrlRequest**](ReturnUrlRequest.md)| | [optional]
829
+
830
+ ### Return type
831
+
832
+ [**ViewUrl**](ViewUrl.md)
833
+
834
+ ### Authorization
835
+
836
+ No authorization required
837
+
838
+ ### HTTP request headers
839
+
840
+ - **Content-Type**: Not defined
841
+ - **Accept**: application/json
842
+
843
+
844
+
845
+ # **create_tabs**
846
+ > Tabs create_tabs(account_id, envelope_id, recipient_id, opts)
847
+
848
+ Adds tabs for a recipient.
849
+
850
+ Adds one or more tabs for a recipient.
851
+
852
+ ### Example
853
+ ```ruby
854
+ # load the gem
855
+ require 'docusign_esign'
856
+
857
+ api_instance = DocuSign_eSign::EnvelopesApi.new
858
+
859
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
860
+
861
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
862
+
863
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
864
+
865
+ opts = {
866
+ tabs: DocuSign_eSign::Tabs.new # Tabs |
867
+ }
868
+
869
+ begin
870
+ #Adds tabs for a recipient.
871
+ result = api_instance.create_tabs(account_id, envelope_id, recipient_id, opts)
872
+ p result
873
+ rescue DocuSign_eSign::ApiError => e
874
+ puts "Exception when calling EnvelopesApi->create_tabs: #{e}"
875
+ end
876
+ ```
877
+
878
+ ### Parameters
879
+
880
+ Name | Type | Description | Notes
881
+ ------------- | ------------- | ------------- | -------------
882
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
883
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
884
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
885
+ **tabs** | [**Tabs**](Tabs.md)| | [optional]
886
+
887
+ ### Return type
888
+
889
+ [**Tabs**](Tabs.md)
890
+
891
+ ### Authorization
892
+
893
+ No authorization required
894
+
895
+ ### HTTP request headers
896
+
897
+ - **Content-Type**: Not defined
898
+ - **Accept**: application/json
899
+
900
+
901
+
902
+ # **create_view_link**
903
+ > ViewUrl create_view_link(account_id, envelope_id, opts)
904
+
905
+ Reserved: Returns a URL to the secure link view UI.
906
+
907
+ Reserved: Returns a URL that allows you to embed the secure link view of the DocuSign UI in your applications.
908
+
909
+ ### Example
910
+ ```ruby
911
+ # load the gem
912
+ require 'docusign_esign'
913
+
914
+ api_instance = DocuSign_eSign::EnvelopesApi.new
915
+
916
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
917
+
918
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
919
+
920
+ opts = {
921
+ view_link_request: DocuSign_eSign::ViewLinkRequest.new # ViewLinkRequest |
922
+ }
923
+
924
+ begin
925
+ #Reserved: Returns a URL to the secure link view UI.
926
+ result = api_instance.create_view_link(account_id, envelope_id, opts)
927
+ p result
928
+ rescue DocuSign_eSign::ApiError => e
929
+ puts "Exception when calling EnvelopesApi->create_view_link: #{e}"
930
+ end
931
+ ```
932
+
933
+ ### Parameters
934
+
935
+ Name | Type | Description | Notes
936
+ ------------- | ------------- | ------------- | -------------
937
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
938
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
939
+ **view_link_request** | [**ViewLinkRequest**](ViewLinkRequest.md)| | [optional]
940
+
941
+ ### Return type
942
+
943
+ [**ViewUrl**](ViewUrl.md)
944
+
945
+ ### Authorization
946
+
947
+ No authorization required
948
+
949
+ ### HTTP request headers
950
+
951
+ - **Content-Type**: Not defined
952
+ - **Accept**: application/json
953
+
954
+
955
+
956
+ # **delete_attachments**
957
+ > EnvelopeAttachmentsResult delete_attachments(account_id, envelope_id, opts)
958
+
959
+ Delete one or more attachments from a DRAFT envelope.
960
+
961
+ ### Example
962
+ ```ruby
963
+ # load the gem
964
+ require 'docusign_esign'
965
+
966
+ api_instance = DocuSign_eSign::EnvelopesApi.new
967
+
968
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
969
+
970
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
971
+
972
+ opts = {
973
+ envelope_attachments_request: DocuSign_eSign::EnvelopeAttachmentsRequest.new # EnvelopeAttachmentsRequest |
974
+ }
975
+
976
+ begin
977
+ #Delete one or more attachments from a DRAFT envelope.
978
+ result = api_instance.delete_attachments(account_id, envelope_id, opts)
979
+ p result
980
+ rescue DocuSign_eSign::ApiError => e
981
+ puts "Exception when calling EnvelopesApi->delete_attachments: #{e}"
982
+ end
983
+ ```
984
+
985
+ ### Parameters
986
+
987
+ Name | Type | Description | Notes
988
+ ------------- | ------------- | ------------- | -------------
989
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
990
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
991
+ **envelope_attachments_request** | [**EnvelopeAttachmentsRequest**](EnvelopeAttachmentsRequest.md)| | [optional]
992
+
993
+ ### Return type
994
+
995
+ [**EnvelopeAttachmentsResult**](EnvelopeAttachmentsResult.md)
996
+
997
+ ### Authorization
998
+
999
+ No authorization required
1000
+
1001
+ ### HTTP request headers
1002
+
1003
+ - **Content-Type**: Not defined
1004
+ - **Accept**: application/json
1005
+
1006
+
1007
+
1008
+ # **delete_chunked_upload**
1009
+ > ChunkedUploadResponse delete_chunked_upload(account_id, chunked_upload_id)
1010
+
1011
+ Delete an existing ChunkedUpload.
1012
+
1013
+ ### Example
1014
+ ```ruby
1015
+ # load the gem
1016
+ require 'docusign_esign'
1017
+
1018
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1019
+
1020
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1021
+
1022
+ chunked_upload_id = "chunked_upload_id_example" # String |
1023
+
1024
+
1025
+ begin
1026
+ #Delete an existing ChunkedUpload.
1027
+ result = api_instance.delete_chunked_upload(account_id, chunked_upload_id)
1028
+ p result
1029
+ rescue DocuSign_eSign::ApiError => e
1030
+ puts "Exception when calling EnvelopesApi->delete_chunked_upload: #{e}"
1031
+ end
1032
+ ```
1033
+
1034
+ ### Parameters
1035
+
1036
+ Name | Type | Description | Notes
1037
+ ------------- | ------------- | ------------- | -------------
1038
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1039
+ **chunked_upload_id** | **String**| |
1040
+
1041
+ ### Return type
1042
+
1043
+ [**ChunkedUploadResponse**](ChunkedUploadResponse.md)
1044
+
1045
+ ### Authorization
1046
+
1047
+ No authorization required
1048
+
1049
+ ### HTTP request headers
1050
+
1051
+ - **Content-Type**: Not defined
1052
+ - **Accept**: application/json
1053
+
1054
+
1055
+
1056
+ # **delete_custom_fields**
1057
+ > CustomFields delete_custom_fields(account_id, envelope_id, opts)
1058
+
1059
+ Deletes envelope custom fields for draft and in-process envelopes.
1060
+
1061
+ Deletes envelope custom fields for draft and in-process envelopes.
1062
+
1063
+ ### Example
1064
+ ```ruby
1065
+ # load the gem
1066
+ require 'docusign_esign'
1067
+
1068
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1069
+
1070
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1071
+
1072
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1073
+
1074
+ opts = {
1075
+ custom_fields: DocuSign_eSign::CustomFields.new # CustomFields |
1076
+ }
1077
+
1078
+ begin
1079
+ #Deletes envelope custom fields for draft and in-process envelopes.
1080
+ result = api_instance.delete_custom_fields(account_id, envelope_id, opts)
1081
+ p result
1082
+ rescue DocuSign_eSign::ApiError => e
1083
+ puts "Exception when calling EnvelopesApi->delete_custom_fields: #{e}"
1084
+ end
1085
+ ```
1086
+
1087
+ ### Parameters
1088
+
1089
+ Name | Type | Description | Notes
1090
+ ------------- | ------------- | ------------- | -------------
1091
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1092
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1093
+ **custom_fields** | [**CustomFields**](CustomFields.md)| | [optional]
1094
+
1095
+ ### Return type
1096
+
1097
+ [**CustomFields**](CustomFields.md)
1098
+
1099
+ ### Authorization
1100
+
1101
+ No authorization required
1102
+
1103
+ ### HTTP request headers
1104
+
1105
+ - **Content-Type**: Not defined
1106
+ - **Accept**: application/json
1107
+
1108
+
1109
+
1110
+ # **delete_document_fields**
1111
+ > DocumentFieldsInformation delete_document_fields(account_id, document_id, envelope_id, opts)
1112
+
1113
+ Deletes custom document fields from an existing envelope document.
1114
+
1115
+ Deletes custom document fields from an existing envelope document.
1116
+
1117
+ ### Example
1118
+ ```ruby
1119
+ # load the gem
1120
+ require 'docusign_esign'
1121
+
1122
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1123
+
1124
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1125
+
1126
+ document_id = "document_id_example" # String | The ID of the document being accessed.
1127
+
1128
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1129
+
1130
+ opts = {
1131
+ document_fields_information: DocuSign_eSign::DocumentFieldsInformation.new # DocumentFieldsInformation |
1132
+ }
1133
+
1134
+ begin
1135
+ #Deletes custom document fields from an existing envelope document.
1136
+ result = api_instance.delete_document_fields(account_id, document_id, envelope_id, opts)
1137
+ p result
1138
+ rescue DocuSign_eSign::ApiError => e
1139
+ puts "Exception when calling EnvelopesApi->delete_document_fields: #{e}"
1140
+ end
1141
+ ```
1142
+
1143
+ ### Parameters
1144
+
1145
+ Name | Type | Description | Notes
1146
+ ------------- | ------------- | ------------- | -------------
1147
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1148
+ **document_id** | **String**| The ID of the document being accessed. |
1149
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1150
+ **document_fields_information** | [**DocumentFieldsInformation**](DocumentFieldsInformation.md)| | [optional]
1151
+
1152
+ ### Return type
1153
+
1154
+ [**DocumentFieldsInformation**](DocumentFieldsInformation.md)
1155
+
1156
+ ### Authorization
1157
+
1158
+ No authorization required
1159
+
1160
+ ### HTTP request headers
1161
+
1162
+ - **Content-Type**: Not defined
1163
+ - **Accept**: application/json
1164
+
1165
+
1166
+
1167
+ # **delete_document_page**
1168
+ > delete_document_page(account_id, document_id, envelope_id, page_number)
1169
+
1170
+ Deletes a page from a document in an envelope.
1171
+
1172
+ Deletes a page from a document in an envelope based on the page number.
1173
+
1174
+ ### Example
1175
+ ```ruby
1176
+ # load the gem
1177
+ require 'docusign_esign'
1178
+
1179
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1180
+
1181
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1182
+
1183
+ document_id = "document_id_example" # String | The ID of the document being accessed.
1184
+
1185
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1186
+
1187
+ page_number = "page_number_example" # String | The page number being accessed.
1188
+
1189
+
1190
+ begin
1191
+ #Deletes a page from a document in an envelope.
1192
+ api_instance.delete_document_page(account_id, document_id, envelope_id, page_number)
1193
+ rescue DocuSign_eSign::ApiError => e
1194
+ puts "Exception when calling EnvelopesApi->delete_document_page: #{e}"
1195
+ end
1196
+ ```
1197
+
1198
+ ### Parameters
1199
+
1200
+ Name | Type | Description | Notes
1201
+ ------------- | ------------- | ------------- | -------------
1202
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1203
+ **document_id** | **String**| The ID of the document being accessed. |
1204
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1205
+ **page_number** | **String**| The page number being accessed. |
1206
+
1207
+ ### Return type
1208
+
1209
+ nil (empty response body)
1210
+
1211
+ ### Authorization
1212
+
1213
+ No authorization required
1214
+
1215
+ ### HTTP request headers
1216
+
1217
+ - **Content-Type**: Not defined
1218
+ - **Accept**: application/json
1219
+
1220
+
1221
+
1222
+ # **delete_documents**
1223
+ > EnvelopeDocumentsResult delete_documents(account_id, envelope_id, opts)
1224
+
1225
+ Deletes documents from a draft envelope.
1226
+
1227
+ Deletes one or more documents from an existing draft envelope.
1228
+
1229
+ ### Example
1230
+ ```ruby
1231
+ # load the gem
1232
+ require 'docusign_esign'
1233
+
1234
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1235
+
1236
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1237
+
1238
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1239
+
1240
+ opts = {
1241
+ envelope_definition: DocuSign_eSign::EnvelopeDefinition.new # EnvelopeDefinition |
1242
+ }
1243
+
1244
+ begin
1245
+ #Deletes documents from a draft envelope.
1246
+ result = api_instance.delete_documents(account_id, envelope_id, opts)
1247
+ p result
1248
+ rescue DocuSign_eSign::ApiError => e
1249
+ puts "Exception when calling EnvelopesApi->delete_documents: #{e}"
1250
+ end
1251
+ ```
1252
+
1253
+ ### Parameters
1254
+
1255
+ Name | Type | Description | Notes
1256
+ ------------- | ------------- | ------------- | -------------
1257
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1258
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1259
+ **envelope_definition** | [**EnvelopeDefinition**](EnvelopeDefinition.md)| | [optional]
1260
+
1261
+ ### Return type
1262
+
1263
+ [**EnvelopeDocumentsResult**](EnvelopeDocumentsResult.md)
1264
+
1265
+ ### Authorization
1266
+
1267
+ No authorization required
1268
+
1269
+ ### HTTP request headers
1270
+
1271
+ - **Content-Type**: Not defined
1272
+ - **Accept**: application/json
1273
+
1274
+
1275
+
1276
+ # **delete_email_settings**
1277
+ > EmailSettings delete_email_settings(account_id, envelope_id)
1278
+
1279
+ Deletes the email setting overrides for an envelope.
1280
+
1281
+ Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
1282
+
1283
+ ### Example
1284
+ ```ruby
1285
+ # load the gem
1286
+ require 'docusign_esign'
1287
+
1288
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1289
+
1290
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1291
+
1292
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1293
+
1294
+
1295
+ begin
1296
+ #Deletes the email setting overrides for an envelope.
1297
+ result = api_instance.delete_email_settings(account_id, envelope_id)
1298
+ p result
1299
+ rescue DocuSign_eSign::ApiError => e
1300
+ puts "Exception when calling EnvelopesApi->delete_email_settings: #{e}"
1301
+ end
1302
+ ```
1303
+
1304
+ ### Parameters
1305
+
1306
+ Name | Type | Description | Notes
1307
+ ------------- | ------------- | ------------- | -------------
1308
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1309
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1310
+
1311
+ ### Return type
1312
+
1313
+ [**EmailSettings**](EmailSettings.md)
1314
+
1315
+ ### Authorization
1316
+
1317
+ No authorization required
1318
+
1319
+ ### HTTP request headers
1320
+
1321
+ - **Content-Type**: Not defined
1322
+ - **Accept**: application/json
1323
+
1324
+
1325
+
1326
+ # **delete_lock**
1327
+ > LockInformation delete_lock(account_id, envelope_id)
1328
+
1329
+ Deletes an envelope lock.
1330
+
1331
+ Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
1332
+
1333
+ ### Example
1334
+ ```ruby
1335
+ # load the gem
1336
+ require 'docusign_esign'
1337
+
1338
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1339
+
1340
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1341
+
1342
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1343
+
1344
+
1345
+ begin
1346
+ #Deletes an envelope lock.
1347
+ result = api_instance.delete_lock(account_id, envelope_id)
1348
+ p result
1349
+ rescue DocuSign_eSign::ApiError => e
1350
+ puts "Exception when calling EnvelopesApi->delete_lock: #{e}"
1351
+ end
1352
+ ```
1353
+
1354
+ ### Parameters
1355
+
1356
+ Name | Type | Description | Notes
1357
+ ------------- | ------------- | ------------- | -------------
1358
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1359
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1360
+
1361
+ ### Return type
1362
+
1363
+ [**LockInformation**](LockInformation.md)
1364
+
1365
+ ### Authorization
1366
+
1367
+ No authorization required
1368
+
1369
+ ### HTTP request headers
1370
+
1371
+ - **Content-Type**: Not defined
1372
+ - **Accept**: application/json
1373
+
1374
+
1375
+
1376
+ # **delete_recipient**
1377
+ > Recipients delete_recipient(account_id, envelope_id, recipient_id)
1378
+
1379
+ Deletes a recipient from an envelope.
1380
+
1381
+ Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
1382
+
1383
+ ### Example
1384
+ ```ruby
1385
+ # load the gem
1386
+ require 'docusign_esign'
1387
+
1388
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1389
+
1390
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1391
+
1392
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1393
+
1394
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
1395
+
1396
+
1397
+ begin
1398
+ #Deletes a recipient from an envelope.
1399
+ result = api_instance.delete_recipient(account_id, envelope_id, recipient_id)
1400
+ p result
1401
+ rescue DocuSign_eSign::ApiError => e
1402
+ puts "Exception when calling EnvelopesApi->delete_recipient: #{e}"
1403
+ end
1404
+ ```
1405
+
1406
+ ### Parameters
1407
+
1408
+ Name | Type | Description | Notes
1409
+ ------------- | ------------- | ------------- | -------------
1410
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1411
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1412
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
1413
+
1414
+ ### Return type
1415
+
1416
+ [**Recipients**](Recipients.md)
1417
+
1418
+ ### Authorization
1419
+
1420
+ No authorization required
1421
+
1422
+ ### HTTP request headers
1423
+
1424
+ - **Content-Type**: Not defined
1425
+ - **Accept**: application/json
1426
+
1427
+
1428
+
1429
+ # **delete_recipients**
1430
+ > Recipients delete_recipients(account_id, envelope_id, opts)
1431
+
1432
+ Deletes recipients from an envelope.
1433
+
1434
+ Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
1435
+
1436
+ ### Example
1437
+ ```ruby
1438
+ # load the gem
1439
+ require 'docusign_esign'
1440
+
1441
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1442
+
1443
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1444
+
1445
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1446
+
1447
+ opts = {
1448
+ recipients: DocuSign_eSign::Recipients.new # Recipients |
1449
+ }
1450
+
1451
+ begin
1452
+ #Deletes recipients from an envelope.
1453
+ result = api_instance.delete_recipients(account_id, envelope_id, opts)
1454
+ p result
1455
+ rescue DocuSign_eSign::ApiError => e
1456
+ puts "Exception when calling EnvelopesApi->delete_recipients: #{e}"
1457
+ end
1458
+ ```
1459
+
1460
+ ### Parameters
1461
+
1462
+ Name | Type | Description | Notes
1463
+ ------------- | ------------- | ------------- | -------------
1464
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1465
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1466
+ **recipients** | [**Recipients**](Recipients.md)| | [optional]
1467
+
1468
+ ### Return type
1469
+
1470
+ [**Recipients**](Recipients.md)
1471
+
1472
+ ### Authorization
1473
+
1474
+ No authorization required
1475
+
1476
+ ### HTTP request headers
1477
+
1478
+ - **Content-Type**: Not defined
1479
+ - **Accept**: application/json
1480
+
1481
+
1482
+
1483
+ # **delete_tabs**
1484
+ > Tabs delete_tabs(account_id, envelope_id, recipient_id, opts)
1485
+
1486
+ Deletes the tabs associated with a recipient.
1487
+
1488
+ Deletes one or more tabs associated with a recipient in a draft envelope.
1489
+
1490
+ ### Example
1491
+ ```ruby
1492
+ # load the gem
1493
+ require 'docusign_esign'
1494
+
1495
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1496
+
1497
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1498
+
1499
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1500
+
1501
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
1502
+
1503
+ opts = {
1504
+ tabs: DocuSign_eSign::Tabs.new # Tabs |
1505
+ }
1506
+
1507
+ begin
1508
+ #Deletes the tabs associated with a recipient.
1509
+ result = api_instance.delete_tabs(account_id, envelope_id, recipient_id, opts)
1510
+ p result
1511
+ rescue DocuSign_eSign::ApiError => e
1512
+ puts "Exception when calling EnvelopesApi->delete_tabs: #{e}"
1513
+ end
1514
+ ```
1515
+
1516
+ ### Parameters
1517
+
1518
+ Name | Type | Description | Notes
1519
+ ------------- | ------------- | ------------- | -------------
1520
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1521
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1522
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
1523
+ **tabs** | [**Tabs**](Tabs.md)| | [optional]
1524
+
1525
+ ### Return type
1526
+
1527
+ [**Tabs**](Tabs.md)
1528
+
1529
+ ### Authorization
1530
+
1531
+ No authorization required
1532
+
1533
+ ### HTTP request headers
1534
+
1535
+ - **Content-Type**: Not defined
1536
+ - **Accept**: application/json
1537
+
1538
+
1539
+
1540
+ # **delete_templates_from_document**
1541
+ > delete_templates_from_document(account_id, document_id, envelope_id, template_id)
1542
+
1543
+ Deletes a template from a document in an existing envelope.
1544
+
1545
+ Deletes the specified template from a document in an existing envelope.
1546
+
1547
+ ### Example
1548
+ ```ruby
1549
+ # load the gem
1550
+ require 'docusign_esign'
1551
+
1552
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1553
+
1554
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1555
+
1556
+ document_id = "document_id_example" # String | The ID of the document being accessed.
1557
+
1558
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1559
+
1560
+ template_id = "template_id_example" # String | The ID of the template being accessed.
1561
+
1562
+
1563
+ begin
1564
+ #Deletes a template from a document in an existing envelope.
1565
+ api_instance.delete_templates_from_document(account_id, document_id, envelope_id, template_id)
1566
+ rescue DocuSign_eSign::ApiError => e
1567
+ puts "Exception when calling EnvelopesApi->delete_templates_from_document: #{e}"
1568
+ end
1569
+ ```
1570
+
1571
+ ### Parameters
1572
+
1573
+ Name | Type | Description | Notes
1574
+ ------------- | ------------- | ------------- | -------------
1575
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1576
+ **document_id** | **String**| The ID of the document being accessed. |
1577
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1578
+ **template_id** | **String**| The ID of the template being accessed. |
1579
+
1580
+ ### Return type
1581
+
1582
+ nil (empty response body)
1583
+
1584
+ ### Authorization
1585
+
1586
+ No authorization required
1587
+
1588
+ ### HTTP request headers
1589
+
1590
+ - **Content-Type**: Not defined
1591
+ - **Accept**: application/json
1592
+
1593
+
1594
+
1595
+ # **delete_view_link**
1596
+ > delete_view_link(account_id, envelope_id)
1597
+
1598
+ Reserved: Expires a secure view link.
1599
+
1600
+ Reserved: Expires a secure view link
1601
+
1602
+ ### Example
1603
+ ```ruby
1604
+ # load the gem
1605
+ require 'docusign_esign'
1606
+
1607
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1608
+
1609
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1610
+
1611
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1612
+
1613
+
1614
+ begin
1615
+ #Reserved: Expires a secure view link.
1616
+ api_instance.delete_view_link(account_id, envelope_id)
1617
+ rescue DocuSign_eSign::ApiError => e
1618
+ puts "Exception when calling EnvelopesApi->delete_view_link: #{e}"
1619
+ end
1620
+ ```
1621
+
1622
+ ### Parameters
1623
+
1624
+ Name | Type | Description | Notes
1625
+ ------------- | ------------- | ------------- | -------------
1626
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1627
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1628
+
1629
+ ### Return type
1630
+
1631
+ nil (empty response body)
1632
+
1633
+ ### Authorization
1634
+
1635
+ No authorization required
1636
+
1637
+ ### HTTP request headers
1638
+
1639
+ - **Content-Type**: Not defined
1640
+ - **Accept**: application/json
1641
+
1642
+
1643
+
1644
+ # **get_attachment**
1645
+ > get_attachment(account_id, attachment_id, envelope_id)
1646
+
1647
+ Retrieves an attachment from the envelope.
1648
+
1649
+ ### Example
1650
+ ```ruby
1651
+ # load the gem
1652
+ require 'docusign_esign'
1653
+
1654
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1655
+
1656
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1657
+
1658
+ attachment_id = "attachment_id_example" # String |
1659
+
1660
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1661
+
1662
+
1663
+ begin
1664
+ #Retrieves an attachment from the envelope.
1665
+ api_instance.get_attachment(account_id, attachment_id, envelope_id)
1666
+ rescue DocuSign_eSign::ApiError => e
1667
+ puts "Exception when calling EnvelopesApi->get_attachment: #{e}"
1668
+ end
1669
+ ```
1670
+
1671
+ ### Parameters
1672
+
1673
+ Name | Type | Description | Notes
1674
+ ------------- | ------------- | ------------- | -------------
1675
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1676
+ **attachment_id** | **String**| |
1677
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1678
+
1679
+ ### Return type
1680
+
1681
+ nil (empty response body)
1682
+
1683
+ ### Authorization
1684
+
1685
+ No authorization required
1686
+
1687
+ ### HTTP request headers
1688
+
1689
+ - **Content-Type**: Not defined
1690
+ - **Accept**: application/json
1691
+
1692
+
1693
+
1694
+ # **get_attachments**
1695
+ > EnvelopeAttachmentsResult get_attachments(account_id, envelope_id)
1696
+
1697
+ Returns a list of attachments associated with the specified envelope
1698
+
1699
+ ### Example
1700
+ ```ruby
1701
+ # load the gem
1702
+ require 'docusign_esign'
1703
+
1704
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1705
+
1706
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1707
+
1708
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1709
+
1710
+
1711
+ begin
1712
+ #Returns a list of attachments associated with the specified envelope
1713
+ result = api_instance.get_attachments(account_id, envelope_id)
1714
+ p result
1715
+ rescue DocuSign_eSign::ApiError => e
1716
+ puts "Exception when calling EnvelopesApi->get_attachments: #{e}"
1717
+ end
1718
+ ```
1719
+
1720
+ ### Parameters
1721
+
1722
+ Name | Type | Description | Notes
1723
+ ------------- | ------------- | ------------- | -------------
1724
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1725
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1726
+
1727
+ ### Return type
1728
+
1729
+ [**EnvelopeAttachmentsResult**](EnvelopeAttachmentsResult.md)
1730
+
1731
+ ### Authorization
1732
+
1733
+ No authorization required
1734
+
1735
+ ### HTTP request headers
1736
+
1737
+ - **Content-Type**: Not defined
1738
+ - **Accept**: application/json
1739
+
1740
+
1741
+
1742
+ # **get_chunked_upload**
1743
+ > ChunkedUploadResponse get_chunked_upload(account_id, chunked_upload_id, opts)
1744
+
1745
+ Retrieves the current metadata of a ChunkedUpload.
1746
+
1747
+ ### Example
1748
+ ```ruby
1749
+ # load the gem
1750
+ require 'docusign_esign'
1751
+
1752
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1753
+
1754
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1755
+
1756
+ chunked_upload_id = "chunked_upload_id_example" # String |
1757
+
1758
+ opts = {
1759
+ include: "include_example" # String |
1760
+ }
1761
+
1762
+ begin
1763
+ #Retrieves the current metadata of a ChunkedUpload.
1764
+ result = api_instance.get_chunked_upload(account_id, chunked_upload_id, opts)
1765
+ p result
1766
+ rescue DocuSign_eSign::ApiError => e
1767
+ puts "Exception when calling EnvelopesApi->get_chunked_upload: #{e}"
1768
+ end
1769
+ ```
1770
+
1771
+ ### Parameters
1772
+
1773
+ Name | Type | Description | Notes
1774
+ ------------- | ------------- | ------------- | -------------
1775
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1776
+ **chunked_upload_id** | **String**| |
1777
+ **include** | **String**| | [optional]
1778
+
1779
+ ### Return type
1780
+
1781
+ [**ChunkedUploadResponse**](ChunkedUploadResponse.md)
1782
+
1783
+ ### Authorization
1784
+
1785
+ No authorization required
1786
+
1787
+ ### HTTP request headers
1788
+
1789
+ - **Content-Type**: Not defined
1790
+ - **Accept**: application/json
1791
+
1792
+
1793
+
1794
+ # **get_consumer_disclosure**
1795
+ > ConsumerDisclosure get_consumer_disclosure(account_id, envelope_id, lang_code, recipient_id, opts)
1796
+
1797
+ Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
1798
+
1799
+ Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
1800
+
1801
+ ### Example
1802
+ ```ruby
1803
+ # load the gem
1804
+ require 'docusign_esign'
1805
+
1806
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1807
+
1808
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1809
+
1810
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1811
+
1812
+ lang_code = "lang_code_example" # String | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
1813
+
1814
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
1815
+
1816
+ opts = {
1817
+ lang_code2: "lang_code_example" # String |
1818
+ }
1819
+
1820
+ begin
1821
+ #Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
1822
+ result = api_instance.get_consumer_disclosure(account_id, envelope_id, lang_code, recipient_id, opts)
1823
+ p result
1824
+ rescue DocuSign_eSign::ApiError => e
1825
+ puts "Exception when calling EnvelopesApi->get_consumer_disclosure: #{e}"
1826
+ end
1827
+ ```
1828
+
1829
+ ### Parameters
1830
+
1831
+ Name | Type | Description | Notes
1832
+ ------------- | ------------- | ------------- | -------------
1833
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1834
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1835
+ **lang_code** | **String**| The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
1836
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
1837
+ **lang_code2** | **String**| | [optional]
1838
+
1839
+ ### Return type
1840
+
1841
+ [**ConsumerDisclosure**](ConsumerDisclosure.md)
1842
+
1843
+ ### Authorization
1844
+
1845
+ No authorization required
1846
+
1847
+ ### HTTP request headers
1848
+
1849
+ - **Content-Type**: Not defined
1850
+ - **Accept**: application/json
1851
+
1852
+
1853
+
1854
+ # **get_consumer_disclosure_default**
1855
+ > ConsumerDisclosure get_consumer_disclosure_default(account_id, envelope_id, recipient_id, opts)
1856
+
1857
+ Gets the Electronic Record and Signature Disclosure associated with the account.
1858
+
1859
+ Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
1860
+
1861
+ ### Example
1862
+ ```ruby
1863
+ # load the gem
1864
+ require 'docusign_esign'
1865
+
1866
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1867
+
1868
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1869
+
1870
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1871
+
1872
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
1873
+
1874
+ opts = {
1875
+ lang_code: "lang_code_example" # String |
1876
+ }
1877
+
1878
+ begin
1879
+ #Gets the Electronic Record and Signature Disclosure associated with the account.
1880
+ result = api_instance.get_consumer_disclosure_default(account_id, envelope_id, recipient_id, opts)
1881
+ p result
1882
+ rescue DocuSign_eSign::ApiError => e
1883
+ puts "Exception when calling EnvelopesApi->get_consumer_disclosure_default: #{e}"
1884
+ end
1885
+ ```
1886
+
1887
+ ### Parameters
1888
+
1889
+ Name | Type | Description | Notes
1890
+ ------------- | ------------- | ------------- | -------------
1891
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1892
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1893
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
1894
+ **lang_code** | **String**| | [optional]
1895
+
1896
+ ### Return type
1897
+
1898
+ [**ConsumerDisclosure**](ConsumerDisclosure.md)
1899
+
1900
+ ### Authorization
1901
+
1902
+ No authorization required
1903
+
1904
+ ### HTTP request headers
1905
+
1906
+ - **Content-Type**: Not defined
1907
+ - **Accept**: application/json
1908
+
1909
+
1910
+
1911
+ # **get_document**
1912
+ > File get_document(account_id, document_id, envelope_id, opts)
1913
+
1914
+ Gets a document from an envelope.
1915
+
1916
+ Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
1917
+
1918
+ ### Example
1919
+ ```ruby
1920
+ # load the gem
1921
+ require 'docusign_esign'
1922
+
1923
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1924
+
1925
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1926
+
1927
+ document_id = "document_id_example" # String | The ID of the document being accessed.
1928
+
1929
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1930
+
1931
+ opts = {
1932
+ certificate: "certificate_example", # String | When set to **false**, the envelope signing certificate is removed from the download.
1933
+ encoding: "encoding_example", # String |
1934
+ encrypt: "encrypt_example", # String | When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.
1935
+ language: "language_example", # String | Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).
1936
+ recipient_id: "recipient_id_example", # String |
1937
+ show_changes: "show_changes_example", # String | When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.
1938
+ watermark: "watermark_example" # String | When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.
1939
+ }
1940
+
1941
+ begin
1942
+ #Gets a document from an envelope.
1943
+ result = api_instance.get_document(account_id, document_id, envelope_id, opts)
1944
+ p result
1945
+ rescue DocuSign_eSign::ApiError => e
1946
+ puts "Exception when calling EnvelopesApi->get_document: #{e}"
1947
+ end
1948
+ ```
1949
+
1950
+ ### Parameters
1951
+
1952
+ Name | Type | Description | Notes
1953
+ ------------- | ------------- | ------------- | -------------
1954
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1955
+ **document_id** | **String**| The ID of the document being accessed. |
1956
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
1957
+ **certificate** | **String**| When set to **false**, the envelope signing certificate is removed from the download. | [optional]
1958
+ **encoding** | **String**| | [optional]
1959
+ **encrypt** | **String**| When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API. | [optional]
1960
+ **language** | **String**| Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). | [optional]
1961
+ **recipient_id** | **String**| | [optional]
1962
+ **show_changes** | **String**| When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. | [optional]
1963
+ **watermark** | **String**| When set to **true**, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark. | [optional]
1964
+
1965
+ ### Return type
1966
+
1967
+ **File**
1968
+
1969
+ ### Authorization
1970
+
1971
+ No authorization required
1972
+
1973
+ ### HTTP request headers
1974
+
1975
+ - **Content-Type**: Not defined
1976
+ - **Accept**: application/pdf
1977
+
1978
+
1979
+
1980
+ # **get_document_page_image**
1981
+ > File get_document_page_image(account_id, document_id, envelope_id, page_number, opts)
1982
+
1983
+ Gets a page image from an envelope for display.
1984
+
1985
+ Retrieves a page image for display from the specified envelope.
1986
+
1987
+ ### Example
1988
+ ```ruby
1989
+ # load the gem
1990
+ require 'docusign_esign'
1991
+
1992
+ api_instance = DocuSign_eSign::EnvelopesApi.new
1993
+
1994
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1995
+
1996
+ document_id = "document_id_example" # String | The ID of the document being accessed.
1997
+
1998
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
1999
+
2000
+ page_number = "page_number_example" # String | The page number being accessed.
2001
+
2002
+ opts = {
2003
+ dpi: "dpi_example", # String | Sets the dpi for the image.
2004
+ max_height: "max_height_example", # String | Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting.
2005
+ max_width: "max_width_example", # String | Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting.
2006
+ show_changes: "show_changes_example" # String |
2007
+ }
2008
+
2009
+ begin
2010
+ #Gets a page image from an envelope for display.
2011
+ result = api_instance.get_document_page_image(account_id, document_id, envelope_id, page_number, opts)
2012
+ p result
2013
+ rescue DocuSign_eSign::ApiError => e
2014
+ puts "Exception when calling EnvelopesApi->get_document_page_image: #{e}"
2015
+ end
2016
+ ```
2017
+
2018
+ ### Parameters
2019
+
2020
+ Name | Type | Description | Notes
2021
+ ------------- | ------------- | ------------- | -------------
2022
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2023
+ **document_id** | **String**| The ID of the document being accessed. |
2024
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2025
+ **page_number** | **String**| The page number being accessed. |
2026
+ **dpi** | **String**| Sets the dpi for the image. | [optional]
2027
+ **max_height** | **String**| Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting. | [optional]
2028
+ **max_width** | **String**| Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting. | [optional]
2029
+ **show_changes** | **String**| | [optional]
2030
+
2031
+ ### Return type
2032
+
2033
+ **File**
2034
+
2035
+ ### Authorization
2036
+
2037
+ No authorization required
2038
+
2039
+ ### HTTP request headers
2040
+
2041
+ - **Content-Type**: Not defined
2042
+ - **Accept**: image/png
2043
+
2044
+
2045
+
2046
+ # **get_email_settings**
2047
+ > EmailSettings get_email_settings(account_id, envelope_id)
2048
+
2049
+ Gets the email setting overrides for an envelope.
2050
+
2051
+ Retrieves the email override settings for the specified envelope.
2052
+
2053
+ ### Example
2054
+ ```ruby
2055
+ # load the gem
2056
+ require 'docusign_esign'
2057
+
2058
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2059
+
2060
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2061
+
2062
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2063
+
2064
+
2065
+ begin
2066
+ #Gets the email setting overrides for an envelope.
2067
+ result = api_instance.get_email_settings(account_id, envelope_id)
2068
+ p result
2069
+ rescue DocuSign_eSign::ApiError => e
2070
+ puts "Exception when calling EnvelopesApi->get_email_settings: #{e}"
2071
+ end
2072
+ ```
2073
+
2074
+ ### Parameters
2075
+
2076
+ Name | Type | Description | Notes
2077
+ ------------- | ------------- | ------------- | -------------
2078
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2079
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2080
+
2081
+ ### Return type
2082
+
2083
+ [**EmailSettings**](EmailSettings.md)
2084
+
2085
+ ### Authorization
2086
+
2087
+ No authorization required
2088
+
2089
+ ### HTTP request headers
2090
+
2091
+ - **Content-Type**: Not defined
2092
+ - **Accept**: application/json
2093
+
2094
+
2095
+
2096
+ # **get_envelope**
2097
+ > Envelope get_envelope(account_id, envelope_id, opts)
2098
+
2099
+ Gets the status of a envelope.
2100
+
2101
+ Retrieves the overall status for the specified envelope.
2102
+
2103
+ ### Example
2104
+ ```ruby
2105
+ # load the gem
2106
+ require 'docusign_esign'
2107
+
2108
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2109
+
2110
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2111
+
2112
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2113
+
2114
+ opts = {
2115
+ advanced_update: "advanced_update_example", # String | When true, envelope information can be added or modified.
2116
+ include: "include_example" # String |
2117
+ }
2118
+
2119
+ begin
2120
+ #Gets the status of a envelope.
2121
+ result = api_instance.get_envelope(account_id, envelope_id, opts)
2122
+ p result
2123
+ rescue DocuSign_eSign::ApiError => e
2124
+ puts "Exception when calling EnvelopesApi->get_envelope: #{e}"
2125
+ end
2126
+ ```
2127
+
2128
+ ### Parameters
2129
+
2130
+ Name | Type | Description | Notes
2131
+ ------------- | ------------- | ------------- | -------------
2132
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2133
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2134
+ **advanced_update** | **String**| When true, envelope information can be added or modified. | [optional]
2135
+ **include** | **String**| | [optional]
2136
+
2137
+ ### Return type
2138
+
2139
+ [**Envelope**](Envelope.md)
2140
+
2141
+ ### Authorization
2142
+
2143
+ No authorization required
2144
+
2145
+ ### HTTP request headers
2146
+
2147
+ - **Content-Type**: Not defined
2148
+ - **Accept**: application/json
2149
+
2150
+
2151
+
2152
+ # **get_form_data**
2153
+ > EnvelopeFormData get_form_data(account_id, envelope_id)
2154
+
2155
+ Returns envelope form data for an existing envelope.
2156
+
2157
+ ### Example
2158
+ ```ruby
2159
+ # load the gem
2160
+ require 'docusign_esign'
2161
+
2162
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2163
+
2164
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2165
+
2166
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2167
+
2168
+
2169
+ begin
2170
+ #Returns envelope form data for an existing envelope.
2171
+ result = api_instance.get_form_data(account_id, envelope_id)
2172
+ p result
2173
+ rescue DocuSign_eSign::ApiError => e
2174
+ puts "Exception when calling EnvelopesApi->get_form_data: #{e}"
2175
+ end
2176
+ ```
2177
+
2178
+ ### Parameters
2179
+
2180
+ Name | Type | Description | Notes
2181
+ ------------- | ------------- | ------------- | -------------
2182
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2183
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2184
+
2185
+ ### Return type
2186
+
2187
+ [**EnvelopeFormData**](EnvelopeFormData.md)
2188
+
2189
+ ### Authorization
2190
+
2191
+ No authorization required
2192
+
2193
+ ### HTTP request headers
2194
+
2195
+ - **Content-Type**: Not defined
2196
+ - **Accept**: application/json
2197
+
2198
+
2199
+
2200
+ # **get_lock**
2201
+ > LockInformation get_lock(account_id, envelope_id)
2202
+
2203
+ Gets envelope lock information.
2204
+
2205
+ Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header 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.
2206
+
2207
+ ### Example
2208
+ ```ruby
2209
+ # load the gem
2210
+ require 'docusign_esign'
2211
+
2212
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2213
+
2214
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2215
+
2216
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2217
+
2218
+
2219
+ begin
2220
+ #Gets envelope lock information.
2221
+ result = api_instance.get_lock(account_id, envelope_id)
2222
+ p result
2223
+ rescue DocuSign_eSign::ApiError => e
2224
+ puts "Exception when calling EnvelopesApi->get_lock: #{e}"
2225
+ end
2226
+ ```
2227
+
2228
+ ### Parameters
2229
+
2230
+ Name | Type | Description | Notes
2231
+ ------------- | ------------- | ------------- | -------------
2232
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2233
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2234
+
2235
+ ### Return type
2236
+
2237
+ [**LockInformation**](LockInformation.md)
2238
+
2239
+ ### Authorization
2240
+
2241
+ No authorization required
2242
+
2243
+ ### HTTP request headers
2244
+
2245
+ - **Content-Type**: Not defined
2246
+ - **Accept**: application/json
2247
+
2248
+
2249
+
2250
+ # **get_notification_settings**
2251
+ > Notification get_notification_settings(account_id, envelope_id)
2252
+
2253
+ Gets envelope notification information.
2254
+
2255
+ Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
2256
+
2257
+ ### Example
2258
+ ```ruby
2259
+ # load the gem
2260
+ require 'docusign_esign'
2261
+
2262
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2263
+
2264
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2265
+
2266
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2267
+
2268
+
2269
+ begin
2270
+ #Gets envelope notification information.
2271
+ result = api_instance.get_notification_settings(account_id, envelope_id)
2272
+ p result
2273
+ rescue DocuSign_eSign::ApiError => e
2274
+ puts "Exception when calling EnvelopesApi->get_notification_settings: #{e}"
2275
+ end
2276
+ ```
2277
+
2278
+ ### Parameters
2279
+
2280
+ Name | Type | Description | Notes
2281
+ ------------- | ------------- | ------------- | -------------
2282
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2283
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2284
+
2285
+ ### Return type
2286
+
2287
+ [**Notification**](Notification.md)
2288
+
2289
+ ### Authorization
2290
+
2291
+ No authorization required
2292
+
2293
+ ### HTTP request headers
2294
+
2295
+ - **Content-Type**: Not defined
2296
+ - **Accept**: application/json
2297
+
2298
+
2299
+
2300
+ # **get_recipient_document_visibility**
2301
+ > DocumentVisibilityList get_recipient_document_visibility(account_id, envelope_id, recipient_id)
2302
+
2303
+ Returns document visibility for the recipients
2304
+
2305
+ ### Example
2306
+ ```ruby
2307
+ # load the gem
2308
+ require 'docusign_esign'
2309
+
2310
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2311
+
2312
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2313
+
2314
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2315
+
2316
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
2317
+
2318
+
2319
+ begin
2320
+ #Returns document visibility for the recipients
2321
+ result = api_instance.get_recipient_document_visibility(account_id, envelope_id, recipient_id)
2322
+ p result
2323
+ rescue DocuSign_eSign::ApiError => e
2324
+ puts "Exception when calling EnvelopesApi->get_recipient_document_visibility: #{e}"
2325
+ end
2326
+ ```
2327
+
2328
+ ### Parameters
2329
+
2330
+ Name | Type | Description | Notes
2331
+ ------------- | ------------- | ------------- | -------------
2332
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2333
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2334
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
2335
+
2336
+ ### Return type
2337
+
2338
+ [**DocumentVisibilityList**](DocumentVisibilityList.md)
2339
+
2340
+ ### Authorization
2341
+
2342
+ No authorization required
2343
+
2344
+ ### HTTP request headers
2345
+
2346
+ - **Content-Type**: Not defined
2347
+ - **Accept**: application/json
2348
+
2349
+
2350
+
2351
+ # **get_recipient_initials_image**
2352
+ > File get_recipient_initials_image(account_id, envelope_id, recipient_id, opts)
2353
+
2354
+ Gets the initials image for a user.
2355
+
2356
+ Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
2357
+
2358
+ ### Example
2359
+ ```ruby
2360
+ # load the gem
2361
+ require 'docusign_esign'
2362
+
2363
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2364
+
2365
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2366
+
2367
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2368
+
2369
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
2370
+
2371
+ opts = {
2372
+ include_chrome: "include_chrome_example" # String | The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
2373
+ }
2374
+
2375
+ begin
2376
+ #Gets the initials image for a user.
2377
+ result = api_instance.get_recipient_initials_image(account_id, envelope_id, recipient_id, opts)
2378
+ p result
2379
+ rescue DocuSign_eSign::ApiError => e
2380
+ puts "Exception when calling EnvelopesApi->get_recipient_initials_image: #{e}"
2381
+ end
2382
+ ```
2383
+
2384
+ ### Parameters
2385
+
2386
+ Name | Type | Description | Notes
2387
+ ------------- | ------------- | ------------- | -------------
2388
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2389
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2390
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
2391
+ **include_chrome** | **String**| The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. | [optional]
2392
+
2393
+ ### Return type
2394
+
2395
+ **File**
2396
+
2397
+ ### Authorization
2398
+
2399
+ No authorization required
2400
+
2401
+ ### HTTP request headers
2402
+
2403
+ - **Content-Type**: Not defined
2404
+ - **Accept**: image/gif
2405
+
2406
+
2407
+
2408
+ # **get_recipient_signature**
2409
+ > UserSignature get_recipient_signature(account_id, envelope_id, recipient_id)
2410
+
2411
+ Gets signature information for a signer or sign-in-person recipient.
2412
+
2413
+ Retrieves signature information for a signer or sign-in-person recipient.
2414
+
2415
+ ### Example
2416
+ ```ruby
2417
+ # load the gem
2418
+ require 'docusign_esign'
2419
+
2420
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2421
+
2422
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2423
+
2424
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2425
+
2426
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
2427
+
2428
+
2429
+ begin
2430
+ #Gets signature information for a signer or sign-in-person recipient.
2431
+ result = api_instance.get_recipient_signature(account_id, envelope_id, recipient_id)
2432
+ p result
2433
+ rescue DocuSign_eSign::ApiError => e
2434
+ puts "Exception when calling EnvelopesApi->get_recipient_signature: #{e}"
2435
+ end
2436
+ ```
2437
+
2438
+ ### Parameters
2439
+
2440
+ Name | Type | Description | Notes
2441
+ ------------- | ------------- | ------------- | -------------
2442
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2443
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2444
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
2445
+
2446
+ ### Return type
2447
+
2448
+ [**UserSignature**](UserSignature.md)
2449
+
2450
+ ### Authorization
2451
+
2452
+ No authorization required
2453
+
2454
+ ### HTTP request headers
2455
+
2456
+ - **Content-Type**: Not defined
2457
+ - **Accept**: application/json
2458
+
2459
+
2460
+
2461
+ # **get_recipient_signature_image**
2462
+ > File get_recipient_signature_image(account_id, envelope_id, recipient_id, opts)
2463
+
2464
+ Retrieve signature image information for a signer/sign-in-person recipient.
2465
+
2466
+ Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
2467
+
2468
+ ### Example
2469
+ ```ruby
2470
+ # load the gem
2471
+ require 'docusign_esign'
2472
+
2473
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2474
+
2475
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2476
+
2477
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2478
+
2479
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
2480
+
2481
+ opts = {
2482
+ include_chrome: "include_chrome_example" # String | When set to **true**, indicates the chromed version of the signature image should be retrieved.
2483
+ }
2484
+
2485
+ begin
2486
+ #Retrieve signature image information for a signer/sign-in-person recipient.
2487
+ result = api_instance.get_recipient_signature_image(account_id, envelope_id, recipient_id, opts)
2488
+ p result
2489
+ rescue DocuSign_eSign::ApiError => e
2490
+ puts "Exception when calling EnvelopesApi->get_recipient_signature_image: #{e}"
2491
+ end
2492
+ ```
2493
+
2494
+ ### Parameters
2495
+
2496
+ Name | Type | Description | Notes
2497
+ ------------- | ------------- | ------------- | -------------
2498
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2499
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2500
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
2501
+ **include_chrome** | **String**| When set to **true**, indicates the chromed version of the signature image should be retrieved. | [optional]
2502
+
2503
+ ### Return type
2504
+
2505
+ **File**
2506
+
2507
+ ### Authorization
2508
+
2509
+ No authorization required
2510
+
2511
+ ### HTTP request headers
2512
+
2513
+ - **Content-Type**: Not defined
2514
+ - **Accept**: image/gif
2515
+
2516
+
2517
+
2518
+ # **get_template_recipient_document_visibility**
2519
+ > DocumentVisibilityList get_template_recipient_document_visibility(account_id, recipient_id, template_id)
2520
+
2521
+ Returns document visibility for the recipients
2522
+
2523
+ ### Example
2524
+ ```ruby
2525
+ # load the gem
2526
+ require 'docusign_esign'
2527
+
2528
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2529
+
2530
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2531
+
2532
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
2533
+
2534
+ template_id = "template_id_example" # String | The ID of the template being accessed.
2535
+
2536
+
2537
+ begin
2538
+ #Returns document visibility for the recipients
2539
+ result = api_instance.get_template_recipient_document_visibility(account_id, recipient_id, template_id)
2540
+ p result
2541
+ rescue DocuSign_eSign::ApiError => e
2542
+ puts "Exception when calling EnvelopesApi->get_template_recipient_document_visibility: #{e}"
2543
+ end
2544
+ ```
2545
+
2546
+ ### Parameters
2547
+
2548
+ Name | Type | Description | Notes
2549
+ ------------- | ------------- | ------------- | -------------
2550
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2551
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
2552
+ **template_id** | **String**| The ID of the template being accessed. |
2553
+
2554
+ ### Return type
2555
+
2556
+ [**DocumentVisibilityList**](DocumentVisibilityList.md)
2557
+
2558
+ ### Authorization
2559
+
2560
+ No authorization required
2561
+
2562
+ ### HTTP request headers
2563
+
2564
+ - **Content-Type**: Not defined
2565
+ - **Accept**: application/json
2566
+
2567
+
2568
+
2569
+ # **list_audit_events**
2570
+ > EnvelopeAuditEventResponse list_audit_events(account_id, envelope_id)
2571
+
2572
+ Gets the envelope audit events for an envelope.
2573
+
2574
+ Gets the envelope audit events for the specified envelope.
2575
+
2576
+ ### Example
2577
+ ```ruby
2578
+ # load the gem
2579
+ require 'docusign_esign'
2580
+
2581
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2582
+
2583
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2584
+
2585
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2586
+
2587
+
2588
+ begin
2589
+ #Gets the envelope audit events for an envelope.
2590
+ result = api_instance.list_audit_events(account_id, envelope_id)
2591
+ p result
2592
+ rescue DocuSign_eSign::ApiError => e
2593
+ puts "Exception when calling EnvelopesApi->list_audit_events: #{e}"
2594
+ end
2595
+ ```
2596
+
2597
+ ### Parameters
2598
+
2599
+ Name | Type | Description | Notes
2600
+ ------------- | ------------- | ------------- | -------------
2601
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2602
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2603
+
2604
+ ### Return type
2605
+
2606
+ [**EnvelopeAuditEventResponse**](EnvelopeAuditEventResponse.md)
2607
+
2608
+ ### Authorization
2609
+
2610
+ No authorization required
2611
+
2612
+ ### HTTP request headers
2613
+
2614
+ - **Content-Type**: Not defined
2615
+ - **Accept**: application/json
2616
+
2617
+
2618
+
2619
+ # **list_custom_fields**
2620
+ > CustomFieldsEnvelope list_custom_fields(account_id, envelope_id)
2621
+
2622
+ Gets the custom field information for the specified envelope.
2623
+
2624
+ Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.
2625
+
2626
+ ### Example
2627
+ ```ruby
2628
+ # load the gem
2629
+ require 'docusign_esign'
2630
+
2631
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2632
+
2633
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2634
+
2635
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2636
+
2637
+
2638
+ begin
2639
+ #Gets the custom field information for the specified envelope.
2640
+ result = api_instance.list_custom_fields(account_id, envelope_id)
2641
+ p result
2642
+ rescue DocuSign_eSign::ApiError => e
2643
+ puts "Exception when calling EnvelopesApi->list_custom_fields: #{e}"
2644
+ end
2645
+ ```
2646
+
2647
+ ### Parameters
2648
+
2649
+ Name | Type | Description | Notes
2650
+ ------------- | ------------- | ------------- | -------------
2651
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2652
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2653
+
2654
+ ### Return type
2655
+
2656
+ [**CustomFieldsEnvelope**](CustomFieldsEnvelope.md)
2657
+
2658
+ ### Authorization
2659
+
2660
+ No authorization required
2661
+
2662
+ ### HTTP request headers
2663
+
2664
+ - **Content-Type**: Not defined
2665
+ - **Accept**: application/json
2666
+
2667
+
2668
+
2669
+ # **list_document_fields**
2670
+ > DocumentFieldsInformation list_document_fields(account_id, document_id, envelope_id)
2671
+
2672
+ Gets the custom document fields from an existing envelope document.
2673
+
2674
+ Retrieves the custom document field information from an existing envelope document.
2675
+
2676
+ ### Example
2677
+ ```ruby
2678
+ # load the gem
2679
+ require 'docusign_esign'
2680
+
2681
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2682
+
2683
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2684
+
2685
+ document_id = "document_id_example" # String | The ID of the document being accessed.
2686
+
2687
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2688
+
2689
+
2690
+ begin
2691
+ #Gets the custom document fields from an existing envelope document.
2692
+ result = api_instance.list_document_fields(account_id, document_id, envelope_id)
2693
+ p result
2694
+ rescue DocuSign_eSign::ApiError => e
2695
+ puts "Exception when calling EnvelopesApi->list_document_fields: #{e}"
2696
+ end
2697
+ ```
2698
+
2699
+ ### Parameters
2700
+
2701
+ Name | Type | Description | Notes
2702
+ ------------- | ------------- | ------------- | -------------
2703
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2704
+ **document_id** | **String**| The ID of the document being accessed. |
2705
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2706
+
2707
+ ### Return type
2708
+
2709
+ [**DocumentFieldsInformation**](DocumentFieldsInformation.md)
2710
+
2711
+ ### Authorization
2712
+
2713
+ No authorization required
2714
+
2715
+ ### HTTP request headers
2716
+
2717
+ - **Content-Type**: Not defined
2718
+ - **Accept**: application/json
2719
+
2720
+
2721
+
2722
+ # **list_documents**
2723
+ > EnvelopeDocumentsResult list_documents(account_id, envelope_id, opts)
2724
+
2725
+ Gets a list of envelope documents.
2726
+
2727
+ Retrieves a list of documents associated with the specified envelope.
2728
+
2729
+ ### Example
2730
+ ```ruby
2731
+ # load the gem
2732
+ require 'docusign_esign'
2733
+
2734
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2735
+
2736
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2737
+
2738
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2739
+
2740
+ opts = {
2741
+ include_metadata: "include_metadata_example" # String |
2742
+ }
2743
+
2744
+ begin
2745
+ #Gets a list of envelope documents.
2746
+ result = api_instance.list_documents(account_id, envelope_id, opts)
2747
+ p result
2748
+ rescue DocuSign_eSign::ApiError => e
2749
+ puts "Exception when calling EnvelopesApi->list_documents: #{e}"
2750
+ end
2751
+ ```
2752
+
2753
+ ### Parameters
2754
+
2755
+ Name | Type | Description | Notes
2756
+ ------------- | ------------- | ------------- | -------------
2757
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2758
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2759
+ **include_metadata** | **String**| | [optional]
2760
+
2761
+ ### Return type
2762
+
2763
+ [**EnvelopeDocumentsResult**](EnvelopeDocumentsResult.md)
2764
+
2765
+ ### Authorization
2766
+
2767
+ No authorization required
2768
+
2769
+ ### HTTP request headers
2770
+
2771
+ - **Content-Type**: Not defined
2772
+ - **Accept**: application/json
2773
+
2774
+
2775
+
2776
+ # **list_recipients**
2777
+ > Recipients list_recipients(account_id, envelope_id, opts)
2778
+
2779
+ Gets the status of recipients for an envelope.
2780
+
2781
+ Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
2782
+
2783
+ ### Example
2784
+ ```ruby
2785
+ # load the gem
2786
+ require 'docusign_esign'
2787
+
2788
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2789
+
2790
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2791
+
2792
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
2793
+
2794
+ opts = {
2795
+ include_anchor_tab_locations: "include_anchor_tab_locations_example", # String | When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response.
2796
+ include_extended: "include_extended_example", # String | When set to **true**, the extended properties are included in the response.
2797
+ include_metadata: "include_metadata_example", # String |
2798
+ include_tabs: "include_tabs_example" # String | When set to **true**, the tab information associated with the recipient is included in the response.
2799
+ }
2800
+
2801
+ begin
2802
+ #Gets the status of recipients for an envelope.
2803
+ result = api_instance.list_recipients(account_id, envelope_id, opts)
2804
+ p result
2805
+ rescue DocuSign_eSign::ApiError => e
2806
+ puts "Exception when calling EnvelopesApi->list_recipients: #{e}"
2807
+ end
2808
+ ```
2809
+
2810
+ ### Parameters
2811
+
2812
+ Name | Type | Description | Notes
2813
+ ------------- | ------------- | ------------- | -------------
2814
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2815
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
2816
+ **include_anchor_tab_locations** | **String**| When set to **true** and &#x60;include_tabs&#x60; is set to **true**, all tabs with anchor tab properties are included in the response. | [optional]
2817
+ **include_extended** | **String**| When set to **true**, the extended properties are included in the response. | [optional]
2818
+ **include_metadata** | **String**| | [optional]
2819
+ **include_tabs** | **String**| When set to **true**, the tab information associated with the recipient is included in the response. | [optional]
2820
+
2821
+ ### Return type
2822
+
2823
+ [**Recipients**](Recipients.md)
2824
+
2825
+ ### Authorization
2826
+
2827
+ No authorization required
2828
+
2829
+ ### HTTP request headers
2830
+
2831
+ - **Content-Type**: Not defined
2832
+ - **Accept**: application/json
2833
+
2834
+
2835
+
2836
+ # **list_status**
2837
+ > EnvelopesInformation list_status(account_id, opts)
2838
+
2839
+ Gets the envelope status for the specified envelopes.
2840
+
2841
+ Retrieves the envelope status for the specified envelopes.
2842
+
2843
+ ### Example
2844
+ ```ruby
2845
+ # load the gem
2846
+ require 'docusign_esign'
2847
+
2848
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2849
+
2850
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2851
+
2852
+ opts = {
2853
+ email: "email_example", # String |
2854
+ from_date: "from_date_example", # String |
2855
+ start_position: "start_position_example", # String |
2856
+ to_date: "to_date_example", # String |
2857
+ envelope_ids_request: DocuSign_eSign::EnvelopeIdsRequest.new # EnvelopeIdsRequest |
2858
+ }
2859
+
2860
+ begin
2861
+ #Gets the envelope status for the specified envelopes.
2862
+ result = api_instance.list_status(account_id, opts)
2863
+ p result
2864
+ rescue DocuSign_eSign::ApiError => e
2865
+ puts "Exception when calling EnvelopesApi->list_status: #{e}"
2866
+ end
2867
+ ```
2868
+
2869
+ ### Parameters
2870
+
2871
+ Name | Type | Description | Notes
2872
+ ------------- | ------------- | ------------- | -------------
2873
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2874
+ **email** | **String**| | [optional]
2875
+ **from_date** | **String**| | [optional]
2876
+ **start_position** | **String**| | [optional]
2877
+ **to_date** | **String**| | [optional]
2878
+ **envelope_ids_request** | [**EnvelopeIdsRequest**](EnvelopeIdsRequest.md)| | [optional]
2879
+
2880
+ ### Return type
2881
+
2882
+ [**EnvelopesInformation**](EnvelopesInformation.md)
2883
+
2884
+ ### Authorization
2885
+
2886
+ No authorization required
2887
+
2888
+ ### HTTP request headers
2889
+
2890
+ - **Content-Type**: Not defined
2891
+ - **Accept**: application/json
2892
+
2893
+
2894
+
2895
+ # **list_status_changes**
2896
+ > EnvelopesInformation list_status_changes(account_id, opts)
2897
+
2898
+ Gets status changes for one or more envelopes.
2899
+
2900
+ Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for \"any status change\" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` &mdash; the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of \"`Created`,`Sent`\", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.
2901
+
2902
+ ### Example
2903
+ ```ruby
2904
+ # load the gem
2905
+ require 'docusign_esign'
2906
+
2907
+ api_instance = DocuSign_eSign::EnvelopesApi.new
2908
+
2909
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
2910
+
2911
+ opts = {
2912
+ ac_status: "ac_status_example", # String | Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.
2913
+ block: "block_example", # String |
2914
+ count: "count_example", # String |
2915
+ custom_field: "custom_field_example", # String | This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding '%' (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \"Region\" and you want to search for all envelopes where the value is \"West\" you would use the query: `?custom_field=Region=West`. Example 2: To search for envelopes where the `ApplicationID` custom field has the value or partial value of \"DocuSign\" in field, the query would be: `?custom_field=ApplicationId=%DocuSign%` This would find envelopes where the custom field value is \"DocuSign for Salesforce\" or \"DocuSign envelope.\"
2916
+ email: "email_example", # String |
2917
+ envelope_ids: "envelope_ids_example", # String |
2918
+ exclude: "exclude_example", # String |
2919
+ folder_ids: "folder_ids_example", # String |
2920
+ folder_types: "folder_types_example", # String |
2921
+ from_date: "from_date_example", # String | The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless 'envelopeId's are used.
2922
+ from_to_status: "from_to_status_example", # String | This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
2923
+ include: "include_example", # String |
2924
+ intersecting_folder_ids: "intersecting_folder_ids_example", # String |
2925
+ order: "order_example", # String |
2926
+ order_by: "order_by_example", # String |
2927
+ powerformids: "powerformids_example", # String |
2928
+ search_text: "search_text_example", # String |
2929
+ start_position: "start_position_example", # String |
2930
+ status: "status_example", # String | The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
2931
+ to_date: "to_date_example", # String | Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the `to_date`.
2932
+ transaction_ids: "transaction_ids_example", # String | If included in the query string, this is a comma separated list of envelope `transactionId`s. If included in the `request_body`, this is a list of envelope `transactionId`s. ###### Note: `transactionId`s are only valid in the DocuSign system for seven days.
2933
+ user_filter: "user_filter_example", # String |
2934
+ user_id: "user_id_example", # String |
2935
+ user_name: "user_name_example" # String |
2936
+ }
2937
+
2938
+ begin
2939
+ #Gets status changes for one or more envelopes.
2940
+ result = api_instance.list_status_changes(account_id, opts)
2941
+ p result
2942
+ rescue DocuSign_eSign::ApiError => e
2943
+ puts "Exception when calling EnvelopesApi->list_status_changes: #{e}"
2944
+ end
2945
+ ```
2946
+
2947
+ ### Parameters
2948
+
2949
+ Name | Type | Description | Notes
2950
+ ------------- | ------------- | ------------- | -------------
2951
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
2952
+ **ac_status** | **String**| Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. | [optional]
2953
+ **block** | **String**| | [optional]
2954
+ **count** | **String**| | [optional]
2955
+ **custom_field** | **String**| This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding &#39;%&#39; (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called \&quot;Region\&quot; and you want to search for all envelopes where the value is \&quot;West\&quot; you would use the query: &#x60;?custom_field&#x3D;Region&#x3D;West&#x60;. Example 2: To search for envelopes where the &#x60;ApplicationID&#x60; custom field has the value or partial value of \&quot;DocuSign\&quot; in field, the query would be: &#x60;?custom_field&#x3D;ApplicationId&#x3D;%DocuSign%&#x60; This would find envelopes where the custom field value is \&quot;DocuSign for Salesforce\&quot; or \&quot;DocuSign envelope.\&quot; | [optional]
2956
+ **email** | **String**| | [optional]
2957
+ **envelope_ids** | **String**| | [optional]
2958
+ **exclude** | **String**| | [optional]
2959
+ **folder_ids** | **String**| | [optional]
2960
+ **folder_types** | **String**| | [optional]
2961
+ **from_date** | **String**| The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. This is required unless &#39;envelopeId&#39;s are used. | [optional]
2962
+ **from_to_status** | **String**| This is the status type checked for in the &#x60;from_date&#x60;/&#x60;to_date&#x60; period. If &#x60;changed&#x60; is specified, then envelopes that changed status during the period are found. If for example, &#x60;created&#x60; is specified, then envelopes created during the period are found. Default is &#x60;changed&#x60;. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. | [optional]
2963
+ **include** | **String**| | [optional]
2964
+ **intersecting_folder_ids** | **String**| | [optional]
2965
+ **order** | **String**| | [optional]
2966
+ **order_by** | **String**| | [optional]
2967
+ **powerformids** | **String**| | [optional]
2968
+ **search_text** | **String**| | [optional]
2969
+ **start_position** | **String**| | [optional]
2970
+ **status** | **String**| The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. | [optional]
2971
+ **to_date** | **String**| Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If no entry, the system uses the time of the call as the &#x60;to_date&#x60;. | [optional]
2972
+ **transaction_ids** | **String**| If included in the query string, this is a comma separated list of envelope &#x60;transactionId&#x60;s. If included in the &#x60;request_body&#x60;, this is a list of envelope &#x60;transactionId&#x60;s. ###### Note: &#x60;transactionId&#x60;s are only valid in the DocuSign system for seven days. | [optional]
2973
+ **user_filter** | **String**| | [optional]
2974
+ **user_id** | **String**| | [optional]
2975
+ **user_name** | **String**| | [optional]
2976
+
2977
+ ### Return type
2978
+
2979
+ [**EnvelopesInformation**](EnvelopesInformation.md)
2980
+
2981
+ ### Authorization
2982
+
2983
+ No authorization required
2984
+
2985
+ ### HTTP request headers
2986
+
2987
+ - **Content-Type**: Not defined
2988
+ - **Accept**: application/json
2989
+
2990
+
2991
+
2992
+ # **list_tabs**
2993
+ > Tabs list_tabs(account_id, envelope_id, recipient_id, opts)
2994
+
2995
+ Gets the tabs information for a signer or sign-in-person recipient in an envelope.
2996
+
2997
+ Retrieves information about the tabs associated with a recipient in a draft envelope.
2998
+
2999
+ ### Example
3000
+ ```ruby
3001
+ # load the gem
3002
+ require 'docusign_esign'
3003
+
3004
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3005
+
3006
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3007
+
3008
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3009
+
3010
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
3011
+
3012
+ opts = {
3013
+ include_anchor_tab_locations: "include_anchor_tab_locations_example", # String | When set to **true**, all tabs with anchor tab properties are included in the response.
3014
+ include_metadata: "include_metadata_example" # String |
3015
+ }
3016
+
3017
+ begin
3018
+ #Gets the tabs information for a signer or sign-in-person recipient in an envelope.
3019
+ result = api_instance.list_tabs(account_id, envelope_id, recipient_id, opts)
3020
+ p result
3021
+ rescue DocuSign_eSign::ApiError => e
3022
+ puts "Exception when calling EnvelopesApi->list_tabs: #{e}"
3023
+ end
3024
+ ```
3025
+
3026
+ ### Parameters
3027
+
3028
+ Name | Type | Description | Notes
3029
+ ------------- | ------------- | ------------- | -------------
3030
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3031
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3032
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
3033
+ **include_anchor_tab_locations** | **String**| When set to **true**, all tabs with anchor tab properties are included in the response. | [optional]
3034
+ **include_metadata** | **String**| | [optional]
3035
+
3036
+ ### Return type
3037
+
3038
+ [**Tabs**](Tabs.md)
3039
+
3040
+ ### Authorization
3041
+
3042
+ No authorization required
3043
+
3044
+ ### HTTP request headers
3045
+
3046
+ - **Content-Type**: Not defined
3047
+ - **Accept**: application/json
3048
+
3049
+
3050
+
3051
+ # **list_templates**
3052
+ > TemplateInformation list_templates(account_id, envelope_id, opts)
3053
+
3054
+ Get List of Templates used in an Envelope
3055
+
3056
+ This returns a list of the server-side templates, their name and ID, used in an envelope.
3057
+
3058
+ ### Example
3059
+ ```ruby
3060
+ # load the gem
3061
+ require 'docusign_esign'
3062
+
3063
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3064
+
3065
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3066
+
3067
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3068
+
3069
+ opts = {
3070
+ include: "include_example" # String | The possible values are: matching_applied – This returns template matching information for the template.
3071
+ }
3072
+
3073
+ begin
3074
+ #Get List of Templates used in an Envelope
3075
+ result = api_instance.list_templates(account_id, envelope_id, opts)
3076
+ p result
3077
+ rescue DocuSign_eSign::ApiError => e
3078
+ puts "Exception when calling EnvelopesApi->list_templates: #{e}"
3079
+ end
3080
+ ```
3081
+
3082
+ ### Parameters
3083
+
3084
+ Name | Type | Description | Notes
3085
+ ------------- | ------------- | ------------- | -------------
3086
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3087
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3088
+ **include** | **String**| The possible values are: matching_applied – This returns template matching information for the template. | [optional]
3089
+
3090
+ ### Return type
3091
+
3092
+ [**TemplateInformation**](TemplateInformation.md)
3093
+
3094
+ ### Authorization
3095
+
3096
+ No authorization required
3097
+
3098
+ ### HTTP request headers
3099
+
3100
+ - **Content-Type**: Not defined
3101
+ - **Accept**: application/json
3102
+
3103
+
3104
+
3105
+ # **list_templates_for_document**
3106
+ > TemplateInformation list_templates_for_document(account_id, document_id, envelope_id, opts)
3107
+
3108
+ Gets the templates associated with a document in an existing envelope.
3109
+
3110
+ Retrieves the templates associated with a document in the specified envelope.
3111
+
3112
+ ### Example
3113
+ ```ruby
3114
+ # load the gem
3115
+ require 'docusign_esign'
3116
+
3117
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3118
+
3119
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3120
+
3121
+ document_id = "document_id_example" # String | The ID of the document being accessed.
3122
+
3123
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3124
+
3125
+ opts = {
3126
+ include: "include_example" # String |
3127
+ }
3128
+
3129
+ begin
3130
+ #Gets the templates associated with a document in an existing envelope.
3131
+ result = api_instance.list_templates_for_document(account_id, document_id, envelope_id, opts)
3132
+ p result
3133
+ rescue DocuSign_eSign::ApiError => e
3134
+ puts "Exception when calling EnvelopesApi->list_templates_for_document: #{e}"
3135
+ end
3136
+ ```
3137
+
3138
+ ### Parameters
3139
+
3140
+ Name | Type | Description | Notes
3141
+ ------------- | ------------- | ------------- | -------------
3142
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3143
+ **document_id** | **String**| The ID of the document being accessed. |
3144
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3145
+ **include** | **String**| | [optional]
3146
+
3147
+ ### Return type
3148
+
3149
+ [**TemplateInformation**](TemplateInformation.md)
3150
+
3151
+ ### Authorization
3152
+
3153
+ No authorization required
3154
+
3155
+ ### HTTP request headers
3156
+
3157
+ - **Content-Type**: Not defined
3158
+ - **Accept**: application/json
3159
+
3160
+
3161
+
3162
+ # **put_attachment**
3163
+ > EnvelopeAttachmentsResult put_attachment(account_id, attachment_id, envelope_id, opts)
3164
+
3165
+ Add an attachment to a DRAFT or IN-PROCESS envelope.
3166
+
3167
+ ### Example
3168
+ ```ruby
3169
+ # load the gem
3170
+ require 'docusign_esign'
3171
+
3172
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3173
+
3174
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3175
+
3176
+ attachment_id = "attachment_id_example" # String |
3177
+
3178
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3179
+
3180
+ opts = {
3181
+ attachment: DocuSign_eSign::Attachment.new # Attachment |
3182
+ }
3183
+
3184
+ begin
3185
+ #Add an attachment to a DRAFT or IN-PROCESS envelope.
3186
+ result = api_instance.put_attachment(account_id, attachment_id, envelope_id, opts)
3187
+ p result
3188
+ rescue DocuSign_eSign::ApiError => e
3189
+ puts "Exception when calling EnvelopesApi->put_attachment: #{e}"
3190
+ end
3191
+ ```
3192
+
3193
+ ### Parameters
3194
+
3195
+ Name | Type | Description | Notes
3196
+ ------------- | ------------- | ------------- | -------------
3197
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3198
+ **attachment_id** | **String**| |
3199
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3200
+ **attachment** | [**Attachment**](Attachment.md)| | [optional]
3201
+
3202
+ ### Return type
3203
+
3204
+ [**EnvelopeAttachmentsResult**](EnvelopeAttachmentsResult.md)
3205
+
3206
+ ### Authorization
3207
+
3208
+ No authorization required
3209
+
3210
+ ### HTTP request headers
3211
+
3212
+ - **Content-Type**: Not defined
3213
+ - **Accept**: application/json
3214
+
3215
+
3216
+
3217
+ # **put_attachments**
3218
+ > EnvelopeAttachmentsResult put_attachments(account_id, envelope_id, opts)
3219
+
3220
+ Add one or more attachments to a DRAFT or IN-PROCESS envelope.
3221
+
3222
+ ### Example
3223
+ ```ruby
3224
+ # load the gem
3225
+ require 'docusign_esign'
3226
+
3227
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3228
+
3229
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3230
+
3231
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3232
+
3233
+ opts = {
3234
+ envelope_attachments_request: DocuSign_eSign::EnvelopeAttachmentsRequest.new # EnvelopeAttachmentsRequest |
3235
+ }
3236
+
3237
+ begin
3238
+ #Add one or more attachments to a DRAFT or IN-PROCESS envelope.
3239
+ result = api_instance.put_attachments(account_id, envelope_id, opts)
3240
+ p result
3241
+ rescue DocuSign_eSign::ApiError => e
3242
+ puts "Exception when calling EnvelopesApi->put_attachments: #{e}"
3243
+ end
3244
+ ```
3245
+
3246
+ ### Parameters
3247
+
3248
+ Name | Type | Description | Notes
3249
+ ------------- | ------------- | ------------- | -------------
3250
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3251
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3252
+ **envelope_attachments_request** | [**EnvelopeAttachmentsRequest**](EnvelopeAttachmentsRequest.md)| | [optional]
3253
+
3254
+ ### Return type
3255
+
3256
+ [**EnvelopeAttachmentsResult**](EnvelopeAttachmentsResult.md)
3257
+
3258
+ ### Authorization
3259
+
3260
+ No authorization required
3261
+
3262
+ ### HTTP request headers
3263
+
3264
+ - **Content-Type**: Not defined
3265
+ - **Accept**: application/json
3266
+
3267
+
3268
+
3269
+ # **rotate_document_page**
3270
+ > rotate_document_page(account_id, document_id, envelope_id, page_number, opts)
3271
+
3272
+ Rotates page image from an envelope for display.
3273
+
3274
+ Rotates page image from an envelope for display. The page image can be rotated to the left or right.
3275
+
3276
+ ### Example
3277
+ ```ruby
3278
+ # load the gem
3279
+ require 'docusign_esign'
3280
+
3281
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3282
+
3283
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3284
+
3285
+ document_id = "document_id_example" # String | The ID of the document being accessed.
3286
+
3287
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3288
+
3289
+ page_number = "page_number_example" # String | The page number being accessed.
3290
+
3291
+ opts = {
3292
+ page_request: DocuSign_eSign::PageRequest.new # PageRequest |
3293
+ }
3294
+
3295
+ begin
3296
+ #Rotates page image from an envelope for display.
3297
+ api_instance.rotate_document_page(account_id, document_id, envelope_id, page_number, opts)
3298
+ rescue DocuSign_eSign::ApiError => e
3299
+ puts "Exception when calling EnvelopesApi->rotate_document_page: #{e}"
3300
+ end
3301
+ ```
3302
+
3303
+ ### Parameters
3304
+
3305
+ Name | Type | Description | Notes
3306
+ ------------- | ------------- | ------------- | -------------
3307
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3308
+ **document_id** | **String**| The ID of the document being accessed. |
3309
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3310
+ **page_number** | **String**| The page number being accessed. |
3311
+ **page_request** | [**PageRequest**](PageRequest.md)| | [optional]
3312
+
3313
+ ### Return type
3314
+
3315
+ nil (empty response body)
3316
+
3317
+ ### Authorization
3318
+
3319
+ No authorization required
3320
+
3321
+ ### HTTP request headers
3322
+
3323
+ - **Content-Type**: Not defined
3324
+ - **Accept**: application/json
3325
+
3326
+
3327
+
3328
+ # **update**
3329
+ > EnvelopeUpdateSummary update(account_id, envelope_id, opts)
3330
+
3331
+ Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft
3332
+
3333
+ The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {\"status\":\"sent\"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {\"purgeState\":\"purge type\"} to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState=\"documents_queued\"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= \"documents_and_metadata_queued\"` is used in the request, then the documents, attachments, and tabs are deleted.
3334
+
3335
+ ### Example
3336
+ ```ruby
3337
+ # load the gem
3338
+ require 'docusign_esign'
3339
+
3340
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3341
+
3342
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3343
+
3344
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3345
+
3346
+ opts = {
3347
+ advanced_update: "advanced_update_example", # String | When set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.
3348
+ resend_envelope: "resend_envelope_example", # String | When set to **true**, sends the specified envelope again.
3349
+ envelope: DocuSign_eSign::Envelope.new # Envelope |
3350
+ }
3351
+
3352
+ begin
3353
+ #Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft
3354
+ result = api_instance.update(account_id, envelope_id, opts)
3355
+ p result
3356
+ rescue DocuSign_eSign::ApiError => e
3357
+ puts "Exception when calling EnvelopesApi->update: #{e}"
3358
+ end
3359
+ ```
3360
+
3361
+ ### Parameters
3362
+
3363
+ Name | Type | Description | Notes
3364
+ ------------- | ------------- | ------------- | -------------
3365
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3366
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3367
+ **advanced_update** | **String**| When set to **true**, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes. | [optional]
3368
+ **resend_envelope** | **String**| When set to **true**, sends the specified envelope again. | [optional]
3369
+ **envelope** | [**Envelope**](Envelope.md)| | [optional]
3370
+
3371
+ ### Return type
3372
+
3373
+ [**EnvelopeUpdateSummary**](EnvelopeUpdateSummary.md)
3374
+
3375
+ ### Authorization
3376
+
3377
+ No authorization required
3378
+
3379
+ ### HTTP request headers
3380
+
3381
+ - **Content-Type**: Not defined
3382
+ - **Accept**: application/json
3383
+
3384
+
3385
+
3386
+ # **update_chunked_upload**
3387
+ > ChunkedUploadResponse update_chunked_upload(account_id, chunked_upload_id, opts)
3388
+
3389
+ Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
3390
+
3391
+ ### Example
3392
+ ```ruby
3393
+ # load the gem
3394
+ require 'docusign_esign'
3395
+
3396
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3397
+
3398
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3399
+
3400
+ chunked_upload_id = "chunked_upload_id_example" # String |
3401
+
3402
+ opts = {
3403
+ action: "action_example" # String |
3404
+ }
3405
+
3406
+ begin
3407
+ #Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
3408
+ result = api_instance.update_chunked_upload(account_id, chunked_upload_id, opts)
3409
+ p result
3410
+ rescue DocuSign_eSign::ApiError => e
3411
+ puts "Exception when calling EnvelopesApi->update_chunked_upload: #{e}"
3412
+ end
3413
+ ```
3414
+
3415
+ ### Parameters
3416
+
3417
+ Name | Type | Description | Notes
3418
+ ------------- | ------------- | ------------- | -------------
3419
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3420
+ **chunked_upload_id** | **String**| |
3421
+ **action** | **String**| | [optional]
3422
+
3423
+ ### Return type
3424
+
3425
+ [**ChunkedUploadResponse**](ChunkedUploadResponse.md)
3426
+
3427
+ ### Authorization
3428
+
3429
+ No authorization required
3430
+
3431
+ ### HTTP request headers
3432
+
3433
+ - **Content-Type**: Not defined
3434
+ - **Accept**: application/json
3435
+
3436
+
3437
+
3438
+ # **update_chunked_upload_part**
3439
+ > ChunkedUploadResponse update_chunked_upload_part(account_id, chunked_upload_id, chunked_upload_part_seq, opts)
3440
+
3441
+ Add a chunk, a chunk 'part', to an existing ChunkedUpload.
3442
+
3443
+ ### Example
3444
+ ```ruby
3445
+ # load the gem
3446
+ require 'docusign_esign'
3447
+
3448
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3449
+
3450
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3451
+
3452
+ chunked_upload_id = "chunked_upload_id_example" # String |
3453
+
3454
+ chunked_upload_part_seq = "chunked_upload_part_seq_example" # String |
3455
+
3456
+ opts = {
3457
+ chunked_upload_request: DocuSign_eSign::ChunkedUploadRequest.new # ChunkedUploadRequest |
3458
+ }
3459
+
3460
+ begin
3461
+ #Add a chunk, a chunk 'part', to an existing ChunkedUpload.
3462
+ result = api_instance.update_chunked_upload_part(account_id, chunked_upload_id, chunked_upload_part_seq, opts)
3463
+ p result
3464
+ rescue DocuSign_eSign::ApiError => e
3465
+ puts "Exception when calling EnvelopesApi->update_chunked_upload_part: #{e}"
3466
+ end
3467
+ ```
3468
+
3469
+ ### Parameters
3470
+
3471
+ Name | Type | Description | Notes
3472
+ ------------- | ------------- | ------------- | -------------
3473
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3474
+ **chunked_upload_id** | **String**| |
3475
+ **chunked_upload_part_seq** | **String**| |
3476
+ **chunked_upload_request** | [**ChunkedUploadRequest**](ChunkedUploadRequest.md)| | [optional]
3477
+
3478
+ ### Return type
3479
+
3480
+ [**ChunkedUploadResponse**](ChunkedUploadResponse.md)
3481
+
3482
+ ### Authorization
3483
+
3484
+ No authorization required
3485
+
3486
+ ### HTTP request headers
3487
+
3488
+ - **Content-Type**: Not defined
3489
+ - **Accept**: application/json
3490
+
3491
+
3492
+
3493
+ # **update_custom_fields**
3494
+ > CustomFields update_custom_fields(account_id, envelope_id, opts)
3495
+
3496
+ Updates envelope custom fields in an envelope.
3497
+
3498
+ Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
3499
+
3500
+ ### Example
3501
+ ```ruby
3502
+ # load the gem
3503
+ require 'docusign_esign'
3504
+
3505
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3506
+
3507
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3508
+
3509
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3510
+
3511
+ opts = {
3512
+ custom_fields: DocuSign_eSign::CustomFields.new # CustomFields |
3513
+ }
3514
+
3515
+ begin
3516
+ #Updates envelope custom fields in an envelope.
3517
+ result = api_instance.update_custom_fields(account_id, envelope_id, opts)
3518
+ p result
3519
+ rescue DocuSign_eSign::ApiError => e
3520
+ puts "Exception when calling EnvelopesApi->update_custom_fields: #{e}"
3521
+ end
3522
+ ```
3523
+
3524
+ ### Parameters
3525
+
3526
+ Name | Type | Description | Notes
3527
+ ------------- | ------------- | ------------- | -------------
3528
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3529
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3530
+ **custom_fields** | [**CustomFields**](CustomFields.md)| | [optional]
3531
+
3532
+ ### Return type
3533
+
3534
+ [**CustomFields**](CustomFields.md)
3535
+
3536
+ ### Authorization
3537
+
3538
+ No authorization required
3539
+
3540
+ ### HTTP request headers
3541
+
3542
+ - **Content-Type**: Not defined
3543
+ - **Accept**: application/json
3544
+
3545
+
3546
+
3547
+ # **update_document**
3548
+ > update_document(account_id, document_id, envelope_id, opts)
3549
+
3550
+ Adds a document to an existing draft envelope.
3551
+
3552
+ Adds a document to an existing draft envelope.
3553
+
3554
+ ### Example
3555
+ ```ruby
3556
+ # load the gem
3557
+ require 'docusign_esign'
3558
+
3559
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3560
+
3561
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3562
+
3563
+ document_id = "document_id_example" # String | The ID of the document being accessed.
3564
+
3565
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3566
+
3567
+ opts = {
3568
+ apply_document_fields: "apply_document_fields_example" # String |
3569
+ }
3570
+
3571
+ begin
3572
+ #Adds a document to an existing draft envelope.
3573
+ api_instance.update_document(account_id, document_id, envelope_id, opts)
3574
+ rescue DocuSign_eSign::ApiError => e
3575
+ puts "Exception when calling EnvelopesApi->update_document: #{e}"
3576
+ end
3577
+ ```
3578
+
3579
+ ### Parameters
3580
+
3581
+ Name | Type | Description | Notes
3582
+ ------------- | ------------- | ------------- | -------------
3583
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3584
+ **document_id** | **String**| The ID of the document being accessed. |
3585
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3586
+ **apply_document_fields** | **String**| | [optional]
3587
+
3588
+ ### Return type
3589
+
3590
+ nil (empty response body)
3591
+
3592
+ ### Authorization
3593
+
3594
+ No authorization required
3595
+
3596
+ ### HTTP request headers
3597
+
3598
+ - **Content-Type**: Not defined
3599
+ - **Accept**: application/json
3600
+
3601
+
3602
+
3603
+ # **update_document_fields**
3604
+ > DocumentFieldsInformation update_document_fields(account_id, document_id, envelope_id, opts)
3605
+
3606
+ Updates existing custom document fields in an existing envelope document.
3607
+
3608
+ Updates existing custom document fields in an existing envelope document.
3609
+
3610
+ ### Example
3611
+ ```ruby
3612
+ # load the gem
3613
+ require 'docusign_esign'
3614
+
3615
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3616
+
3617
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3618
+
3619
+ document_id = "document_id_example" # String | The ID of the document being accessed.
3620
+
3621
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3622
+
3623
+ opts = {
3624
+ document_fields_information: DocuSign_eSign::DocumentFieldsInformation.new # DocumentFieldsInformation |
3625
+ }
3626
+
3627
+ begin
3628
+ #Updates existing custom document fields in an existing envelope document.
3629
+ result = api_instance.update_document_fields(account_id, document_id, envelope_id, opts)
3630
+ p result
3631
+ rescue DocuSign_eSign::ApiError => e
3632
+ puts "Exception when calling EnvelopesApi->update_document_fields: #{e}"
3633
+ end
3634
+ ```
3635
+
3636
+ ### Parameters
3637
+
3638
+ Name | Type | Description | Notes
3639
+ ------------- | ------------- | ------------- | -------------
3640
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3641
+ **document_id** | **String**| The ID of the document being accessed. |
3642
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3643
+ **document_fields_information** | [**DocumentFieldsInformation**](DocumentFieldsInformation.md)| | [optional]
3644
+
3645
+ ### Return type
3646
+
3647
+ [**DocumentFieldsInformation**](DocumentFieldsInformation.md)
3648
+
3649
+ ### Authorization
3650
+
3651
+ No authorization required
3652
+
3653
+ ### HTTP request headers
3654
+
3655
+ - **Content-Type**: Not defined
3656
+ - **Accept**: application/json
3657
+
3658
+
3659
+
3660
+ # **update_documents**
3661
+ > EnvelopeDocumentsResult update_documents(account_id, envelope_id, opts)
3662
+
3663
+ Adds one or more documents to an existing envelope document.
3664
+
3665
+ Adds one or more documents to an existing envelope document.
3666
+
3667
+ ### Example
3668
+ ```ruby
3669
+ # load the gem
3670
+ require 'docusign_esign'
3671
+
3672
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3673
+
3674
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3675
+
3676
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3677
+
3678
+ opts = {
3679
+ apply_document_fields: "apply_document_fields_example", # String | When true, Document fields can be added or modified while adding or modifying envelope documents.
3680
+ envelope_definition: DocuSign_eSign::EnvelopeDefinition.new # EnvelopeDefinition |
3681
+ }
3682
+
3683
+ begin
3684
+ #Adds one or more documents to an existing envelope document.
3685
+ result = api_instance.update_documents(account_id, envelope_id, opts)
3686
+ p result
3687
+ rescue DocuSign_eSign::ApiError => e
3688
+ puts "Exception when calling EnvelopesApi->update_documents: #{e}"
3689
+ end
3690
+ ```
3691
+
3692
+ ### Parameters
3693
+
3694
+ Name | Type | Description | Notes
3695
+ ------------- | ------------- | ------------- | -------------
3696
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3697
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3698
+ **apply_document_fields** | **String**| When true, Document fields can be added or modified while adding or modifying envelope documents. | [optional]
3699
+ **envelope_definition** | [**EnvelopeDefinition**](EnvelopeDefinition.md)| | [optional]
3700
+
3701
+ ### Return type
3702
+
3703
+ [**EnvelopeDocumentsResult**](EnvelopeDocumentsResult.md)
3704
+
3705
+ ### Authorization
3706
+
3707
+ No authorization required
3708
+
3709
+ ### HTTP request headers
3710
+
3711
+ - **Content-Type**: Not defined
3712
+ - **Accept**: application/json
3713
+
3714
+
3715
+
3716
+ # **update_email_settings**
3717
+ > EmailSettings update_email_settings(account_id, envelope_id, opts)
3718
+
3719
+ Updates the email setting overrides for an envelope.
3720
+
3721
+ Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
3722
+
3723
+ ### Example
3724
+ ```ruby
3725
+ # load the gem
3726
+ require 'docusign_esign'
3727
+
3728
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3729
+
3730
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3731
+
3732
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3733
+
3734
+ opts = {
3735
+ email_settings: DocuSign_eSign::EmailSettings.new # EmailSettings |
3736
+ }
3737
+
3738
+ begin
3739
+ #Updates the email setting overrides for an envelope.
3740
+ result = api_instance.update_email_settings(account_id, envelope_id, opts)
3741
+ p result
3742
+ rescue DocuSign_eSign::ApiError => e
3743
+ puts "Exception when calling EnvelopesApi->update_email_settings: #{e}"
3744
+ end
3745
+ ```
3746
+
3747
+ ### Parameters
3748
+
3749
+ Name | Type | Description | Notes
3750
+ ------------- | ------------- | ------------- | -------------
3751
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3752
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3753
+ **email_settings** | [**EmailSettings**](EmailSettings.md)| | [optional]
3754
+
3755
+ ### Return type
3756
+
3757
+ [**EmailSettings**](EmailSettings.md)
3758
+
3759
+ ### Authorization
3760
+
3761
+ No authorization required
3762
+
3763
+ ### HTTP request headers
3764
+
3765
+ - **Content-Type**: Not defined
3766
+ - **Accept**: application/json
3767
+
3768
+
3769
+
3770
+ # **update_lock**
3771
+ > LockInformation update_lock(account_id, envelope_id, opts)
3772
+
3773
+ Updates an envelope lock.
3774
+
3775
+ Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. 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.
3776
+
3777
+ ### Example
3778
+ ```ruby
3779
+ # load the gem
3780
+ require 'docusign_esign'
3781
+
3782
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3783
+
3784
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3785
+
3786
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3787
+
3788
+ opts = {
3789
+ lock_request: DocuSign_eSign::LockRequest.new # LockRequest |
3790
+ }
3791
+
3792
+ begin
3793
+ #Updates an envelope lock.
3794
+ result = api_instance.update_lock(account_id, envelope_id, opts)
3795
+ p result
3796
+ rescue DocuSign_eSign::ApiError => e
3797
+ puts "Exception when calling EnvelopesApi->update_lock: #{e}"
3798
+ end
3799
+ ```
3800
+
3801
+ ### Parameters
3802
+
3803
+ Name | Type | Description | Notes
3804
+ ------------- | ------------- | ------------- | -------------
3805
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3806
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3807
+ **lock_request** | [**LockRequest**](LockRequest.md)| | [optional]
3808
+
3809
+ ### Return type
3810
+
3811
+ [**LockInformation**](LockInformation.md)
3812
+
3813
+ ### Authorization
3814
+
3815
+ No authorization required
3816
+
3817
+ ### HTTP request headers
3818
+
3819
+ - **Content-Type**: Not defined
3820
+ - **Accept**: application/json
3821
+
3822
+
3823
+
3824
+ # **update_notification_settings**
3825
+ > Notification update_notification_settings(account_id, envelope_id, opts)
3826
+
3827
+ Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
3828
+
3829
+ ### Example
3830
+ ```ruby
3831
+ # load the gem
3832
+ require 'docusign_esign'
3833
+
3834
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3835
+
3836
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3837
+
3838
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3839
+
3840
+ opts = {
3841
+ envelope_notification_request: DocuSign_eSign::EnvelopeNotificationRequest.new # EnvelopeNotificationRequest |
3842
+ }
3843
+
3844
+ begin
3845
+ #Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
3846
+ result = api_instance.update_notification_settings(account_id, envelope_id, opts)
3847
+ p result
3848
+ rescue DocuSign_eSign::ApiError => e
3849
+ puts "Exception when calling EnvelopesApi->update_notification_settings: #{e}"
3850
+ end
3851
+ ```
3852
+
3853
+ ### Parameters
3854
+
3855
+ Name | Type | Description | Notes
3856
+ ------------- | ------------- | ------------- | -------------
3857
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3858
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3859
+ **envelope_notification_request** | [**EnvelopeNotificationRequest**](EnvelopeNotificationRequest.md)| | [optional]
3860
+
3861
+ ### Return type
3862
+
3863
+ [**Notification**](Notification.md)
3864
+
3865
+ ### Authorization
3866
+
3867
+ No authorization required
3868
+
3869
+ ### HTTP request headers
3870
+
3871
+ - **Content-Type**: Not defined
3872
+ - **Accept**: application/json
3873
+
3874
+
3875
+
3876
+ # **update_recipient_document_visibility**
3877
+ > DocumentVisibilityList update_recipient_document_visibility(account_id, envelope_id, recipient_id, opts)
3878
+
3879
+ Updates document visibility for the recipients
3880
+
3881
+ ### Example
3882
+ ```ruby
3883
+ # load the gem
3884
+ require 'docusign_esign'
3885
+
3886
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3887
+
3888
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3889
+
3890
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3891
+
3892
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
3893
+
3894
+ opts = {
3895
+ document_visibility_list: DocuSign_eSign::DocumentVisibilityList.new # DocumentVisibilityList |
3896
+ }
3897
+
3898
+ begin
3899
+ #Updates document visibility for the recipients
3900
+ result = api_instance.update_recipient_document_visibility(account_id, envelope_id, recipient_id, opts)
3901
+ p result
3902
+ rescue DocuSign_eSign::ApiError => e
3903
+ puts "Exception when calling EnvelopesApi->update_recipient_document_visibility: #{e}"
3904
+ end
3905
+ ```
3906
+
3907
+ ### Parameters
3908
+
3909
+ Name | Type | Description | Notes
3910
+ ------------- | ------------- | ------------- | -------------
3911
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3912
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3913
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
3914
+ **document_visibility_list** | [**DocumentVisibilityList**](DocumentVisibilityList.md)| | [optional]
3915
+
3916
+ ### Return type
3917
+
3918
+ [**DocumentVisibilityList**](DocumentVisibilityList.md)
3919
+
3920
+ ### Authorization
3921
+
3922
+ No authorization required
3923
+
3924
+ ### HTTP request headers
3925
+
3926
+ - **Content-Type**: Not defined
3927
+ - **Accept**: application/json
3928
+
3929
+
3930
+
3931
+ # **update_recipient_initials_image**
3932
+ > update_recipient_initials_image(account_id, envelope_id, recipient_id)
3933
+
3934
+ Sets the initials image for an accountless signer.
3935
+
3936
+ Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
3937
+
3938
+ ### Example
3939
+ ```ruby
3940
+ # load the gem
3941
+ require 'docusign_esign'
3942
+
3943
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3944
+
3945
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3946
+
3947
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
3948
+
3949
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
3950
+
3951
+
3952
+ begin
3953
+ #Sets the initials image for an accountless signer.
3954
+ api_instance.update_recipient_initials_image(account_id, envelope_id, recipient_id)
3955
+ rescue DocuSign_eSign::ApiError => e
3956
+ puts "Exception when calling EnvelopesApi->update_recipient_initials_image: #{e}"
3957
+ end
3958
+ ```
3959
+
3960
+ ### Parameters
3961
+
3962
+ Name | Type | Description | Notes
3963
+ ------------- | ------------- | ------------- | -------------
3964
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
3965
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
3966
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
3967
+
3968
+ ### Return type
3969
+
3970
+ nil (empty response body)
3971
+
3972
+ ### Authorization
3973
+
3974
+ No authorization required
3975
+
3976
+ ### HTTP request headers
3977
+
3978
+ - **Content-Type**: Not defined
3979
+ - **Accept**: application/json
3980
+
3981
+
3982
+
3983
+ # **update_recipient_signature_image**
3984
+ > update_recipient_signature_image(account_id, envelope_id, recipient_id)
3985
+
3986
+ Sets the signature image for an accountless signer.
3987
+
3988
+ Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
3989
+
3990
+ ### Example
3991
+ ```ruby
3992
+ # load the gem
3993
+ require 'docusign_esign'
3994
+
3995
+ api_instance = DocuSign_eSign::EnvelopesApi.new
3996
+
3997
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
3998
+
3999
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
4000
+
4001
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
4002
+
4003
+
4004
+ begin
4005
+ #Sets the signature image for an accountless signer.
4006
+ api_instance.update_recipient_signature_image(account_id, envelope_id, recipient_id)
4007
+ rescue DocuSign_eSign::ApiError => e
4008
+ puts "Exception when calling EnvelopesApi->update_recipient_signature_image: #{e}"
4009
+ end
4010
+ ```
4011
+
4012
+ ### Parameters
4013
+
4014
+ Name | Type | Description | Notes
4015
+ ------------- | ------------- | ------------- | -------------
4016
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
4017
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
4018
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
4019
+
4020
+ ### Return type
4021
+
4022
+ nil (empty response body)
4023
+
4024
+ ### Authorization
4025
+
4026
+ No authorization required
4027
+
4028
+ ### HTTP request headers
4029
+
4030
+ - **Content-Type**: Not defined
4031
+ - **Accept**: application/json
4032
+
4033
+
4034
+
4035
+ # **update_recipients**
4036
+ > RecipientsUpdateSummary update_recipients(account_id, envelope_id, opts)
4037
+
4038
+ Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
4039
+
4040
+ Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).
4041
+
4042
+ ### Example
4043
+ ```ruby
4044
+ # load the gem
4045
+ require 'docusign_esign'
4046
+
4047
+ api_instance = DocuSign_eSign::EnvelopesApi.new
4048
+
4049
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
4050
+
4051
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
4052
+
4053
+ opts = {
4054
+ resend_envelope: "resend_envelope_example", # String | When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope’s next recipient.
4055
+ recipients: DocuSign_eSign::Recipients.new # Recipients |
4056
+ }
4057
+
4058
+ begin
4059
+ #Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
4060
+ result = api_instance.update_recipients(account_id, envelope_id, opts)
4061
+ p result
4062
+ rescue DocuSign_eSign::ApiError => e
4063
+ puts "Exception when calling EnvelopesApi->update_recipients: #{e}"
4064
+ end
4065
+ ```
4066
+
4067
+ ### Parameters
4068
+
4069
+ Name | Type | Description | Notes
4070
+ ------------- | ------------- | ------------- | -------------
4071
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
4072
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
4073
+ **resend_envelope** | **String**| When set to **true**, resends the envelope if the new recipient&#39;s routing order is before or the same as the envelope’s next recipient. | [optional]
4074
+ **recipients** | [**Recipients**](Recipients.md)| | [optional]
4075
+
4076
+ ### Return type
4077
+
4078
+ [**RecipientsUpdateSummary**](RecipientsUpdateSummary.md)
4079
+
4080
+ ### Authorization
4081
+
4082
+ No authorization required
4083
+
4084
+ ### HTTP request headers
4085
+
4086
+ - **Content-Type**: Not defined
4087
+ - **Accept**: application/json
4088
+
4089
+
4090
+
4091
+ # **update_recipients_document_visibility**
4092
+ > DocumentVisibilityList update_recipients_document_visibility(account_id, envelope_id, opts)
4093
+
4094
+ Updates document visibility for the recipients
4095
+
4096
+ ### Example
4097
+ ```ruby
4098
+ # load the gem
4099
+ require 'docusign_esign'
4100
+
4101
+ api_instance = DocuSign_eSign::EnvelopesApi.new
4102
+
4103
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
4104
+
4105
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
4106
+
4107
+ opts = {
4108
+ document_visibility_list: DocuSign_eSign::DocumentVisibilityList.new # DocumentVisibilityList |
4109
+ }
4110
+
4111
+ begin
4112
+ #Updates document visibility for the recipients
4113
+ result = api_instance.update_recipients_document_visibility(account_id, envelope_id, opts)
4114
+ p result
4115
+ rescue DocuSign_eSign::ApiError => e
4116
+ puts "Exception when calling EnvelopesApi->update_recipients_document_visibility: #{e}"
4117
+ end
4118
+ ```
4119
+
4120
+ ### Parameters
4121
+
4122
+ Name | Type | Description | Notes
4123
+ ------------- | ------------- | ------------- | -------------
4124
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
4125
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
4126
+ **document_visibility_list** | [**DocumentVisibilityList**](DocumentVisibilityList.md)| | [optional]
4127
+
4128
+ ### Return type
4129
+
4130
+ [**DocumentVisibilityList**](DocumentVisibilityList.md)
4131
+
4132
+ ### Authorization
4133
+
4134
+ No authorization required
4135
+
4136
+ ### HTTP request headers
4137
+
4138
+ - **Content-Type**: Not defined
4139
+ - **Accept**: application/json
4140
+
4141
+
4142
+
4143
+ # **update_tabs**
4144
+ > Tabs update_tabs(account_id, envelope_id, recipient_id, opts)
4145
+
4146
+ Updates the tabs for a recipient.
4147
+
4148
+ Updates one or more tabs for a recipient in a draft envelope.
4149
+
4150
+ ### Example
4151
+ ```ruby
4152
+ # load the gem
4153
+ require 'docusign_esign'
4154
+
4155
+ api_instance = DocuSign_eSign::EnvelopesApi.new
4156
+
4157
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
4158
+
4159
+ envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
4160
+
4161
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
4162
+
4163
+ opts = {
4164
+ tabs: DocuSign_eSign::Tabs.new # Tabs |
4165
+ }
4166
+
4167
+ begin
4168
+ #Updates the tabs for a recipient.
4169
+ result = api_instance.update_tabs(account_id, envelope_id, recipient_id, opts)
4170
+ p result
4171
+ rescue DocuSign_eSign::ApiError => e
4172
+ puts "Exception when calling EnvelopesApi->update_tabs: #{e}"
4173
+ end
4174
+ ```
4175
+
4176
+ ### Parameters
4177
+
4178
+ Name | Type | Description | Notes
4179
+ ------------- | ------------- | ------------- | -------------
4180
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
4181
+ **envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
4182
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
4183
+ **tabs** | [**Tabs**](Tabs.md)| | [optional]
4184
+
4185
+ ### Return type
4186
+
4187
+ [**Tabs**](Tabs.md)
4188
+
4189
+ ### Authorization
4190
+
4191
+ No authorization required
4192
+
4193
+ ### HTTP request headers
4194
+
4195
+ - **Content-Type**: Not defined
4196
+ - **Accept**: application/json
4197
+
4198
+
4199
+
4200
+ # **update_template_recipient_document_visibility**
4201
+ > TemplateDocumentVisibilityList update_template_recipient_document_visibility(account_id, recipient_id, template_id, opts)
4202
+
4203
+ Updates document visibility for the recipients
4204
+
4205
+ ### Example
4206
+ ```ruby
4207
+ # load the gem
4208
+ require 'docusign_esign'
4209
+
4210
+ api_instance = DocuSign_eSign::EnvelopesApi.new
4211
+
4212
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
4213
+
4214
+ recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
4215
+
4216
+ template_id = "template_id_example" # String | The ID of the template being accessed.
4217
+
4218
+ opts = {
4219
+ template_document_visibility_list: DocuSign_eSign::TemplateDocumentVisibilityList.new # TemplateDocumentVisibilityList |
4220
+ }
4221
+
4222
+ begin
4223
+ #Updates document visibility for the recipients
4224
+ result = api_instance.update_template_recipient_document_visibility(account_id, recipient_id, template_id, opts)
4225
+ p result
4226
+ rescue DocuSign_eSign::ApiError => e
4227
+ puts "Exception when calling EnvelopesApi->update_template_recipient_document_visibility: #{e}"
4228
+ end
4229
+ ```
4230
+
4231
+ ### Parameters
4232
+
4233
+ Name | Type | Description | Notes
4234
+ ------------- | ------------- | ------------- | -------------
4235
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
4236
+ **recipient_id** | **String**| The ID of the recipient being accessed. |
4237
+ **template_id** | **String**| The ID of the template being accessed. |
4238
+ **template_document_visibility_list** | [**TemplateDocumentVisibilityList**](TemplateDocumentVisibilityList.md)| | [optional]
4239
+
4240
+ ### Return type
4241
+
4242
+ [**TemplateDocumentVisibilityList**](TemplateDocumentVisibilityList.md)
4243
+
4244
+ ### Authorization
4245
+
4246
+ No authorization required
4247
+
4248
+ ### HTTP request headers
4249
+
4250
+ - **Content-Type**: Not defined
4251
+ - **Accept**: application/json
4252
+
4253
+
4254
+
4255
+ # **update_template_recipients_document_visibility**
4256
+ > TemplateDocumentVisibilityList update_template_recipients_document_visibility(account_id, template_id, opts)
4257
+
4258
+ Updates document visibility for the recipients
4259
+
4260
+ ### Example
4261
+ ```ruby
4262
+ # load the gem
4263
+ require 'docusign_esign'
4264
+
4265
+ api_instance = DocuSign_eSign::EnvelopesApi.new
4266
+
4267
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
4268
+
4269
+ template_id = "template_id_example" # String | The ID of the template being accessed.
4270
+
4271
+ opts = {
4272
+ template_document_visibility_list: DocuSign_eSign::TemplateDocumentVisibilityList.new # TemplateDocumentVisibilityList |
4273
+ }
4274
+
4275
+ begin
4276
+ #Updates document visibility for the recipients
4277
+ result = api_instance.update_template_recipients_document_visibility(account_id, template_id, opts)
4278
+ p result
4279
+ rescue DocuSign_eSign::ApiError => e
4280
+ puts "Exception when calling EnvelopesApi->update_template_recipients_document_visibility: #{e}"
4281
+ end
4282
+ ```
4283
+
4284
+ ### Parameters
4285
+
4286
+ Name | Type | Description | Notes
4287
+ ------------- | ------------- | ------------- | -------------
4288
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
4289
+ **template_id** | **String**| The ID of the template being accessed. |
4290
+ **template_document_visibility_list** | [**TemplateDocumentVisibilityList**](TemplateDocumentVisibilityList.md)| | [optional]
4291
+
4292
+ ### Return type
4293
+
4294
+ [**TemplateDocumentVisibilityList**](TemplateDocumentVisibilityList.md)
4295
+
4296
+ ### Authorization
4297
+
4298
+ No authorization required
4299
+
4300
+ ### HTTP request headers
4301
+
4302
+ - **Content-Type**: Not defined
4303
+ - **Accept**: application/json
4304
+
4305
+
4306
+