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
data/docs/Text.md ADDED
@@ -0,0 +1,55 @@
1
+ # DocuSign_eSign::Text
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
+ **conceal_value_on_document** | **String** | When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. | [optional]
16
+ **conditional_parent_label** | **String** | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | [optional]
17
+ **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]
18
+ **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]
19
+ **disable_auto_size** | **String** | When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. | [optional]
20
+ **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]
21
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
22
+ **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]
23
+ **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]
24
+ **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]
25
+ **formula** | **String** | The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] | [optional]
26
+ **height** | **Integer** | Height of the tab in pixels. | [optional]
27
+ **is_payment_amount** | **String** | When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. | [optional]
28
+ **italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
29
+ **locked** | **String** | When set to **true**, the signer cannot change the data of the custom tab. | [optional]
30
+ **max_length** | **Integer** | An optional value that describes the maximum length of the property when the property is a string. | [optional]
31
+ **merge_field** | [**MergeField**](MergeField.md) | | [optional]
32
+ **name** | **String** | Specifies the tool tip text for the tab. | [optional]
33
+ **original_value** | **String** | The initial value of the tab when it was sent to the recipient. | [optional]
34
+ **page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
35
+ **recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
36
+ **require_all** | **String** | When set to **true** and shared is true, information must be entered in this field to complete the envelope. | [optional]
37
+ **required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
38
+ **require_initial_on_shared_change** | **String** | Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. | [optional]
39
+ **sender_required** | **String** | When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. | [optional]
40
+ **shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
41
+ **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]
42
+ **tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
43
+ **tab_label** | **String** | The label string associated with the tab. | [optional]
44
+ **tab_order** | **String** | | [optional]
45
+ **template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
46
+ **template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
47
+ **underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
48
+ **validation_message** | **String** | The message displayed if the custom tab fails input validation (either custom of embedded). | [optional]
49
+ **validation_pattern** | **String** | A regular expressionn used to validate input for the tab. | [optional]
50
+ **value** | **String** | Specifies the value of the tab. | [optional]
51
+ **width** | **Integer** | Width of the tab in pixels. | [optional]
52
+ **x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
53
+ **y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
54
+
55
+
@@ -0,0 +1,14 @@
1
+ # DocuSign_eSign::TextCustomField
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **configuration_type** | **String** | If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. | [optional]
7
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
8
+ **field_id** | **String** | An ID used to specify a custom field. | [optional]
9
+ **name** | **String** | The name of the custom field. | [optional]
10
+ **required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
11
+ **show** | **String** | A boolean indicating if the value should be displayed. | [optional]
12
+ **value** | **String** | The value of the custom field. | [optional]
13
+
14
+
data/docs/Title.md ADDED
@@ -0,0 +1,46 @@
1
+ # DocuSign_eSign::Title
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
+ **conceal_value_on_document** | **String** | When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. | [optional]
16
+ **conditional_parent_label** | **String** | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | [optional]
17
+ **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]
18
+ **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]
19
+ **disable_auto_size** | **String** | When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. | [optional]
20
+ **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]
21
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
22
+ **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]
23
+ **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]
24
+ **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]
25
+ **italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
26
+ **locked** | **String** | When set to **true**, the signer cannot change the data of the custom tab. | [optional]
27
+ **max_length** | **Integer** | An optional value that describes the maximum length of the property when the property is a string. | [optional]
28
+ **merge_field** | [**MergeField**](MergeField.md) | | [optional]
29
+ **name** | **String** | | [optional]
30
+ **original_value** | **String** | The initial value of the tab when it was sent to the recipient. | [optional]
31
+ **page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
32
+ **recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
33
+ **required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
34
+ **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]
35
+ **tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
36
+ **tab_label** | **String** | The label string associated with the tab. | [optional]
37
+ **tab_order** | **String** | | [optional]
38
+ **template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
39
+ **template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
40
+ **underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
41
+ **value** | **String** | Specifies the value of the tab. | [optional]
42
+ **width** | **Integer** | Width of the tab in pixels. | [optional]
43
+ **x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
44
+ **y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
45
+
46
+
@@ -0,0 +1,11 @@
1
+ # DocuSign_eSign::UsageHistory
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **last_sent_date_time** | **String** | The date and time the user last sent an envelope. | [optional]
7
+ **last_signed_date_time** | **String** | The date and time the user last signed an envelope. | [optional]
8
+ **sent_count** | **Integer** | The number of envelopes the user has sent. | [optional]
9
+ **signed_count** | **Integer** | The number of envelopes the user has signed. | [optional]
10
+
11
+
@@ -0,0 +1,15 @@
1
+ # DocuSign_eSign::UserAccountManagementGranularInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **can_manage_admins** | **String** | | [optional]
7
+ **can_manage_admins_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
8
+ **can_manage_groups** | **String** | | [optional]
9
+ **can_manage_groups_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
10
+ **can_manage_sharing** | **String** | | [optional]
11
+ **can_manage_sharing_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
12
+ **can_manage_users** | **String** | | [optional]
13
+ **can_manage_users_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
14
+
15
+
data/docs/UserInfo.md ADDED
@@ -0,0 +1,17 @@
1
+ # DocuSign_eSign::UserInfo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **activation_access_code** | **String** | | [optional]
7
+ **email** | **String** | | [optional]
8
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
9
+ **login_status** | **String** | | [optional]
10
+ **send_activation_email** | **String** | | [optional]
11
+ **uri** | **String** | | [optional]
12
+ **user_id** | **String** | | [optional]
13
+ **user_name** | **String** | | [optional]
14
+ **user_status** | **String** | | [optional]
15
+ **user_type** | **String** | | [optional]
16
+
17
+
@@ -0,0 +1,8 @@
1
+ # DocuSign_eSign::UserInfoList
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **users** | [**Array<UserInfo>**](UserInfo.md) | | [optional]
7
+
8
+
@@ -0,0 +1,41 @@
1
+ # DocuSign_eSign::UserInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **account_management_granular** | [**UserAccountManagementGranularInformation**](UserAccountManagementGranularInformation.md) | | [optional]
7
+ **activation_access_code** | **String** | The activation code the new user must enter when activating their account. | [optional]
8
+ **created_date_time** | **String** | Indicates the date and time the item was created. | [optional]
9
+ **custom_settings** | [**Array<NameValue>**](NameValue.md) | The name/value pair information for the user custom setting. | [optional]
10
+ **email** | **String** | | [optional]
11
+ **enable_connect_for_user** | **String** | Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false. | [optional]
12
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
13
+ **first_name** | **String** | The user’s first name. Maximum Length: 50 characters. | [optional]
14
+ **forgotten_password_info** | [**ForgottenPasswordInformation**](ForgottenPasswordInformation.md) | | [optional]
15
+ **group_list** | [**Array<Group>**](Group.md) | A list of the group information for groups to add the user to. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId. The parameters are: * groupId – The DocuSign group ID for the group. * groupName – The name of the group * permissionProfileId – The ID of the permission profile associated with the group. * groupType – The group type. | [optional]
16
+ **home_address** | [**AddressInformationV2**](AddressInformationV2.md) | | [optional]
17
+ **initials_image_uri** | **String** | Contains the URI for an endpoint that you can use to retrieve the initials image. | [optional]
18
+ **is_admin** | **String** | Determines if the feature set is actively set as part of the plan. | [optional]
19
+ **last_login** | **String** | Shows the date-time when the user last logged on to the system. | [optional]
20
+ **last_name** | **String** | The user’s last name. Maximum Length: 50 characters. | [optional]
21
+ **login_status** | **String** | Shows the current status of the user’s password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed | [optional]
22
+ **middle_name** | **String** | The user’s middle name. Maximum Length: 50 characters. | [optional]
23
+ **password** | **String** | | [optional]
24
+ **password_expiration** | **String** | | [optional]
25
+ **permission_profile_id** | **String** | | [optional]
26
+ **permission_profile_name** | **String** | | [optional]
27
+ **profile_image_uri** | **String** | | [optional]
28
+ **send_activation_on_invalid_login** | **String** | When set to **true**, specifies that an additional activation email is sent to the user if they fail a log on before activating their account. | [optional]
29
+ **signature_image_uri** | **String** | Contains the URI for an endpoint that you can use to retrieve the signature image. | [optional]
30
+ **suffix_name** | **String** | The suffix for the user's name. Maximum Length: 50 characters. | [optional]
31
+ **title** | **String** | The title of the user. | [optional]
32
+ **uri** | **String** | | [optional]
33
+ **user_id** | **String** | | [optional]
34
+ **user_name** | **String** | | [optional]
35
+ **user_profile_last_modified_date** | **String** | | [optional]
36
+ **user_settings** | [**Array<NameValue>**](NameValue.md) | The name/value pair information for user settings. These determine the actions that a user can take in the account. The `[ML:userSettings]` are listed and described below. | [optional]
37
+ **user_status** | **String** | | [optional]
38
+ **user_type** | **String** | | [optional]
39
+ **work_address** | [**AddressInformationV2**](AddressInformationV2.md) | | [optional]
40
+
41
+
@@ -0,0 +1,14 @@
1
+ # DocuSign_eSign::UserInformationList
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **end_position** | **String** | The last position in the result set. | [optional]
7
+ **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]
8
+ **previous_uri** | **String** | The postal code for the billing address. | [optional]
9
+ **result_set_size** | **String** | The number of results returned in this response. | [optional]
10
+ **start_position** | **String** | Starting position of the current result set. | [optional]
11
+ **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]
12
+ **users** | [**Array<UserInformation>**](UserInformation.md) | | [optional]
13
+
14
+
@@ -0,0 +1,11 @@
1
+ # DocuSign_eSign::UserPasswordInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **current_password** | **String** | The user's current password to be changed. | [optional]
7
+ **email** | **String** | The user's email address for the associated account. | [optional]
8
+ **forgotten_password_info** | [**ForgottenPasswordInformation**](ForgottenPasswordInformation.md) | | [optional]
9
+ **new_password** | **String** | The user's new password. | [optional]
10
+
11
+
@@ -0,0 +1,19 @@
1
+ # DocuSign_eSign::UserProfile
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **address** | [**AddressInformationV2**](AddressInformationV2.md) | | [optional]
7
+ **authentication_methods** | [**Array<AuthenticationMethod>**](AuthenticationMethod.md) | These properties cannot be modified in the PUT. Indicates the authentication methods used by the user. | [optional]
8
+ **company_name** | **String** | The name of the user's Company. | [optional]
9
+ **display_organization_info** | **String** | When set to **true**, the user's company and title information are shown on the ID card. | [optional]
10
+ **display_personal_info** | **String** | When set to **true**, the user's Address and Phone number are shown on the ID card. | [optional]
11
+ **display_profile** | **String** | When set to **true**, the user's ID card can be viewed from signed documents and envelope history. | [optional]
12
+ **display_usage_history** | **String** | When set to **true**, the user's usage information is shown on the ID card. | [optional]
13
+ **profile_image_uri** | **String** | | [optional]
14
+ **title** | **String** | | [optional]
15
+ **usage_history** | [**UsageHistory**](UsageHistory.md) | | [optional]
16
+ **user_details** | [**UserInformation**](UserInformation.md) | | [optional]
17
+ **user_profile_last_modified_date** | **String** | | [optional]
18
+
19
+
@@ -0,0 +1,11 @@
1
+ # DocuSign_eSign::UserSettingsInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **account_management_granular** | [**UserAccountManagementGranularInformation**](UserAccountManagementGranularInformation.md) | | [optional]
7
+ **sender_email_notifications** | [**SenderEmailNotifications**](SenderEmailNotifications.md) | | [optional]
8
+ **signer_email_notifications** | [**SignerEmailNotifications**](SignerEmailNotifications.md) | | [optional]
9
+ **user_settings** | [**Array<NameValue>**](NameValue.md) | | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # DocuSign_eSign::UserSharedItem
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
7
+ **shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
8
+ **user** | [**UserInfo**](UserInfo.md) | | [optional]
9
+
10
+
@@ -0,0 +1,20 @@
1
+ # DocuSign_eSign::UserSignature
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **adopted_date_time** | **String** | The date and time the user adopted their signature. | [optional]
7
+ **created_date_time** | **String** | Indicates the date and time the item was created. | [optional]
8
+ **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
9
+ **initials150_image_id** | **String** | | [optional]
10
+ **initials_image_uri** | **String** | Contains the URI for an endpoint that you can use to retrieve the initials image. | [optional]
11
+ **is_default** | **String** | | [optional]
12
+ **signature150_image_id** | **String** | | [optional]
13
+ **signature_font** | **String** | The font type for the signature, if the signature is not drawn. The supported font types are: \"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\" | [optional]
14
+ **signature_id** | **String** | Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. | [optional]
15
+ **signature_image_uri** | **String** | Contains the URI for an endpoint that you can use to retrieve the signature image. | [optional]
16
+ **signature_initials** | **String** | The initials associated with the signature. | [optional]
17
+ **signature_name** | **String** | Specifies the user signature name. | [optional]
18
+ **signature_type** | **String** | | [optional]
19
+
20
+
@@ -0,0 +1,11 @@
1
+ # DocuSign_eSign::UserSignatureDefinition
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **signature_font** | **String** | | [optional]
7
+ **signature_id** | **String** | Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. | [optional]
8
+ **signature_initials** | **String** | | [optional]
9
+ **signature_name** | **String** | Specifies the user signature name. | [optional]
10
+
11
+
@@ -0,0 +1,8 @@
1
+ # DocuSign_eSign::UserSignaturesInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **user_signatures** | [**Array<UserSignature>**](UserSignature.md) | | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # DocuSign_eSign::UserSocialIdResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **social_account_information** | [**Array<SocialAccountInformation>**](SocialAccountInformation.md) | Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.) | [optional]
7
+ **user_id** | **String** | | [optional]
8
+
9
+
data/docs/UsersApi.md ADDED
@@ -0,0 +1,1566 @@
1
+ # DocuSign_eSign::UsersApi
2
+
3
+ All URIs are relative to *https://www.docusign.net/restapi*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](UsersApi.md#create) | **POST** /v2/accounts/{accountId}/users | Adds news user to the specified account.
8
+ [**create_signatures**](UsersApi.md#create_signatures) | **POST** /v2/accounts/{accountId}/users/{userId}/signatures | Adds user Signature and initials images to a Signature.
9
+ [**delete**](UsersApi.md#delete) | **DELETE** /v2/accounts/{accountId}/users | Removes users account privileges.
10
+ [**delete_contact_with_id**](UsersApi.md#delete_contact_with_id) | **DELETE** /v2/accounts/{accountId}/contacts/{contactId} | Replaces a particular contact associated with an account for the DocuSign service.
11
+ [**delete_contacts**](UsersApi.md#delete_contacts) | **DELETE** /v2/accounts/{accountId}/contacts | Delete contacts associated with an account for the DocuSign service.
12
+ [**delete_custom_settings**](UsersApi.md#delete_custom_settings) | **DELETE** /v2/accounts/{accountId}/users/{userId}/custom_settings | Deletes custom user settings for a specified user.
13
+ [**delete_profile_image**](UsersApi.md#delete_profile_image) | **DELETE** /v2/accounts/{accountId}/users/{userId}/profile/image | Deletes the user profile image for the specified user.
14
+ [**delete_signature**](UsersApi.md#delete_signature) | **DELETE** /v2/accounts/{accountId}/users/{userId}/signatures/{signatureId} | Removes removes signature information for the specified user.
15
+ [**delete_signature_image**](UsersApi.md#delete_signature_image) | **DELETE** /v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType} | Deletes the user initials image or the user signature image for the specified user.
16
+ [**get_contact_by_id**](UsersApi.md#get_contact_by_id) | **GET** /v2/accounts/{accountId}/contacts/{contactId} | Gets a particular contact associated with the user's account.
17
+ [**get_information**](UsersApi.md#get_information) | **GET** /v2/accounts/{accountId}/users/{userId} | Gets the user information for a specified user.
18
+ [**get_profile**](UsersApi.md#get_profile) | **GET** /v2/accounts/{accountId}/users/{userId}/profile | Retrieves the user profile for a specified user.
19
+ [**get_profile_image**](UsersApi.md#get_profile_image) | **GET** /v2/accounts/{accountId}/users/{userId}/profile/image | Retrieves the user profile image for the specified user.
20
+ [**get_settings**](UsersApi.md#get_settings) | **GET** /v2/accounts/{accountId}/users/{userId}/settings | Gets the user account settings for a specified user.
21
+ [**get_signature**](UsersApi.md#get_signature) | **GET** /v2/accounts/{accountId}/users/{userId}/signatures/{signatureId} | Gets the user signature information for the specified user.
22
+ [**get_signature_image**](UsersApi.md#get_signature_image) | **GET** /v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType} | Retrieves the user initials image or the user signature image for the specified user.
23
+ [**list**](UsersApi.md#list) | **GET** /v2/accounts/{accountId}/users | Retrieves the list of users for the specified account.
24
+ [**list_custom_settings**](UsersApi.md#list_custom_settings) | **GET** /v2/accounts/{accountId}/users/{userId}/custom_settings | Retrieves the custom user settings for a specified user.
25
+ [**list_signatures**](UsersApi.md#list_signatures) | **GET** /v2/accounts/{accountId}/users/{userId}/signatures | Retrieves a list of user signature definitions for a specified user.
26
+ [**post_contacts**](UsersApi.md#post_contacts) | **POST** /v2/accounts/{accountId}/contacts | Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
27
+ [**put_contacts**](UsersApi.md#put_contacts) | **PUT** /v2/accounts/{accountId}/contacts | Replaces contacts associated with an account for the DocuSign service.
28
+ [**update_custom_settings**](UsersApi.md#update_custom_settings) | **PUT** /v2/accounts/{accountId}/users/{userId}/custom_settings | Adds or updates custom user settings for the specified user.
29
+ [**update_profile**](UsersApi.md#update_profile) | **PUT** /v2/accounts/{accountId}/users/{userId}/profile | Updates the user profile information for the specified user.
30
+ [**update_profile_image**](UsersApi.md#update_profile_image) | **PUT** /v2/accounts/{accountId}/users/{userId}/profile/image | Updates the user profile image for a specified user.
31
+ [**update_settings**](UsersApi.md#update_settings) | **PUT** /v2/accounts/{accountId}/users/{userId}/settings | Updates the user account settings for a specified user.
32
+ [**update_signature**](UsersApi.md#update_signature) | **PUT** /v2/accounts/{accountId}/users/{userId}/signatures/{signatureId} | Updates the user signature for a specified user.
33
+ [**update_signature_image**](UsersApi.md#update_signature_image) | **PUT** /v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType} | Updates the user signature image or user initials image for the specified user.
34
+ [**update_user**](UsersApi.md#update_user) | **PUT** /v2/accounts/{accountId}/users/{userId} | Updates the specified user information.
35
+ [**update_users**](UsersApi.md#update_users) | **PUT** /v2/accounts/{accountId}/users | Change one or more user in the specified account.
36
+
37
+
38
+ # **create**
39
+ > NewUsersSummary create(account_id, opts)
40
+
41
+ Adds news user to the specified account.
42
+
43
+ Adds new users to your account. Set the `userSettings` property in the request to specify the actions the users can perform on the account.
44
+
45
+ ### Example
46
+ ```ruby
47
+ # load the gem
48
+ require 'docusign_esign'
49
+
50
+ api_instance = DocuSign_eSign::UsersApi.new
51
+
52
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
53
+
54
+ opts = {
55
+ new_users_definition: DocuSign_eSign::NewUsersDefinition.new # NewUsersDefinition |
56
+ }
57
+
58
+ begin
59
+ #Adds news user to the specified account.
60
+ result = api_instance.create(account_id, opts)
61
+ p result
62
+ rescue DocuSign_eSign::ApiError => e
63
+ puts "Exception when calling UsersApi->create: #{e}"
64
+ end
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ Name | Type | Description | Notes
70
+ ------------- | ------------- | ------------- | -------------
71
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
72
+ **new_users_definition** | [**NewUsersDefinition**](NewUsersDefinition.md)| | [optional]
73
+
74
+ ### Return type
75
+
76
+ [**NewUsersSummary**](NewUsersSummary.md)
77
+
78
+ ### Authorization
79
+
80
+ No authorization required
81
+
82
+ ### HTTP request headers
83
+
84
+ - **Content-Type**: Not defined
85
+ - **Accept**: application/json
86
+
87
+
88
+
89
+ # **create_signatures**
90
+ > UserSignaturesInformation create_signatures(account_id, user_id, opts)
91
+
92
+ Adds user Signature and initials images to a Signature.
93
+
94
+ Adds a user signature image and/or user initials image to the specified user. The userId property specified in the endpoint must match the authenticated user's userId and the user must be a member of the account. The rules and processes associated with this are: * If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used. * If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images. For each Image part, the Content-Disposition header has a \"filename\" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image. For example: `Content-Disposition: file; filename=\"Ron Test20121127083900\"` If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call. The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary. If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.
95
+
96
+ ### Example
97
+ ```ruby
98
+ # load the gem
99
+ require 'docusign_esign'
100
+
101
+ api_instance = DocuSign_eSign::UsersApi.new
102
+
103
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
104
+
105
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
106
+
107
+ opts = {
108
+ user_signatures_information: DocuSign_eSign::UserSignaturesInformation.new # UserSignaturesInformation |
109
+ }
110
+
111
+ begin
112
+ #Adds user Signature and initials images to a Signature.
113
+ result = api_instance.create_signatures(account_id, user_id, opts)
114
+ p result
115
+ rescue DocuSign_eSign::ApiError => e
116
+ puts "Exception when calling UsersApi->create_signatures: #{e}"
117
+ end
118
+ ```
119
+
120
+ ### Parameters
121
+
122
+ Name | Type | Description | Notes
123
+ ------------- | ------------- | ------------- | -------------
124
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
125
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
126
+ **user_signatures_information** | [**UserSignaturesInformation**](UserSignaturesInformation.md)| | [optional]
127
+
128
+ ### Return type
129
+
130
+ [**UserSignaturesInformation**](UserSignaturesInformation.md)
131
+
132
+ ### Authorization
133
+
134
+ No authorization required
135
+
136
+ ### HTTP request headers
137
+
138
+ - **Content-Type**: Not defined
139
+ - **Accept**: application/json
140
+
141
+
142
+
143
+ # **delete**
144
+ > UsersResponse delete(account_id, opts)
145
+
146
+ Removes users account privileges.
147
+
148
+ This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions. The response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an `errorDetails` node with `errorCode` and `message` properties.
149
+
150
+ ### Example
151
+ ```ruby
152
+ # load the gem
153
+ require 'docusign_esign'
154
+
155
+ api_instance = DocuSign_eSign::UsersApi.new
156
+
157
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
158
+
159
+ opts = {
160
+ user_info_list: DocuSign_eSign::UserInfoList.new # UserInfoList |
161
+ }
162
+
163
+ begin
164
+ #Removes users account privileges.
165
+ result = api_instance.delete(account_id, opts)
166
+ p result
167
+ rescue DocuSign_eSign::ApiError => e
168
+ puts "Exception when calling UsersApi->delete: #{e}"
169
+ end
170
+ ```
171
+
172
+ ### Parameters
173
+
174
+ Name | Type | Description | Notes
175
+ ------------- | ------------- | ------------- | -------------
176
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
177
+ **user_info_list** | [**UserInfoList**](UserInfoList.md)| | [optional]
178
+
179
+ ### Return type
180
+
181
+ [**UsersResponse**](UsersResponse.md)
182
+
183
+ ### Authorization
184
+
185
+ No authorization required
186
+
187
+ ### HTTP request headers
188
+
189
+ - **Content-Type**: Not defined
190
+ - **Accept**: application/json
191
+
192
+
193
+
194
+ # **delete_contact_with_id**
195
+ > ContactUpdateResponse delete_contact_with_id(account_id, contact_id)
196
+
197
+ Replaces a particular contact associated with an account for the DocuSign service.
198
+
199
+ ### Example
200
+ ```ruby
201
+ # load the gem
202
+ require 'docusign_esign'
203
+
204
+ api_instance = DocuSign_eSign::UsersApi.new
205
+
206
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
207
+
208
+ contact_id = "contact_id_example" # String | The unique identifier of a person in the contacts address book.
209
+
210
+
211
+ begin
212
+ #Replaces a particular contact associated with an account for the DocuSign service.
213
+ result = api_instance.delete_contact_with_id(account_id, contact_id)
214
+ p result
215
+ rescue DocuSign_eSign::ApiError => e
216
+ puts "Exception when calling UsersApi->delete_contact_with_id: #{e}"
217
+ end
218
+ ```
219
+
220
+ ### Parameters
221
+
222
+ Name | Type | Description | Notes
223
+ ------------- | ------------- | ------------- | -------------
224
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
225
+ **contact_id** | **String**| The unique identifier of a person in the contacts address book. |
226
+
227
+ ### Return type
228
+
229
+ [**ContactUpdateResponse**](ContactUpdateResponse.md)
230
+
231
+ ### Authorization
232
+
233
+ No authorization required
234
+
235
+ ### HTTP request headers
236
+
237
+ - **Content-Type**: Not defined
238
+ - **Accept**: application/json
239
+
240
+
241
+
242
+ # **delete_contacts**
243
+ > ContactUpdateResponse delete_contacts(account_id, opts)
244
+
245
+ Delete contacts associated with an account for the DocuSign service.
246
+
247
+ ### Example
248
+ ```ruby
249
+ # load the gem
250
+ require 'docusign_esign'
251
+
252
+ api_instance = DocuSign_eSign::UsersApi.new
253
+
254
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
255
+
256
+ opts = {
257
+ contact_mod_request: DocuSign_eSign::ContactModRequest.new # ContactModRequest |
258
+ }
259
+
260
+ begin
261
+ #Delete contacts associated with an account for the DocuSign service.
262
+ result = api_instance.delete_contacts(account_id, opts)
263
+ p result
264
+ rescue DocuSign_eSign::ApiError => e
265
+ puts "Exception when calling UsersApi->delete_contacts: #{e}"
266
+ end
267
+ ```
268
+
269
+ ### Parameters
270
+
271
+ Name | Type | Description | Notes
272
+ ------------- | ------------- | ------------- | -------------
273
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
274
+ **contact_mod_request** | [**ContactModRequest**](ContactModRequest.md)| | [optional]
275
+
276
+ ### Return type
277
+
278
+ [**ContactUpdateResponse**](ContactUpdateResponse.md)
279
+
280
+ ### Authorization
281
+
282
+ No authorization required
283
+
284
+ ### HTTP request headers
285
+
286
+ - **Content-Type**: Not defined
287
+ - **Accept**: application/json
288
+
289
+
290
+
291
+ # **delete_custom_settings**
292
+ > CustomSettingsInformation delete_custom_settings(account_id, user_id, opts)
293
+
294
+ Deletes custom user settings for a specified user.
295
+
296
+ Deletes the specified custom user settings for a single user. ###Deleting Grouped Custom User Settings### If the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are deleted.
297
+
298
+ ### Example
299
+ ```ruby
300
+ # load the gem
301
+ require 'docusign_esign'
302
+
303
+ api_instance = DocuSign_eSign::UsersApi.new
304
+
305
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
306
+
307
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
308
+
309
+ opts = {
310
+ custom_settings_information: DocuSign_eSign::CustomSettingsInformation.new # CustomSettingsInformation |
311
+ }
312
+
313
+ begin
314
+ #Deletes custom user settings for a specified user.
315
+ result = api_instance.delete_custom_settings(account_id, user_id, opts)
316
+ p result
317
+ rescue DocuSign_eSign::ApiError => e
318
+ puts "Exception when calling UsersApi->delete_custom_settings: #{e}"
319
+ end
320
+ ```
321
+
322
+ ### Parameters
323
+
324
+ Name | Type | Description | Notes
325
+ ------------- | ------------- | ------------- | -------------
326
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
327
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
328
+ **custom_settings_information** | [**CustomSettingsInformation**](CustomSettingsInformation.md)| | [optional]
329
+
330
+ ### Return type
331
+
332
+ [**CustomSettingsInformation**](CustomSettingsInformation.md)
333
+
334
+ ### Authorization
335
+
336
+ No authorization required
337
+
338
+ ### HTTP request headers
339
+
340
+ - **Content-Type**: Not defined
341
+ - **Accept**: application/json
342
+
343
+
344
+
345
+ # **delete_profile_image**
346
+ > delete_profile_image(account_id, user_id)
347
+
348
+ Deletes the user profile image for the specified user.
349
+
350
+ Deletes the user profile image from the specified user's profile. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.
351
+
352
+ ### Example
353
+ ```ruby
354
+ # load the gem
355
+ require 'docusign_esign'
356
+
357
+ api_instance = DocuSign_eSign::UsersApi.new
358
+
359
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
360
+
361
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
362
+
363
+
364
+ begin
365
+ #Deletes the user profile image for the specified user.
366
+ api_instance.delete_profile_image(account_id, user_id)
367
+ rescue DocuSign_eSign::ApiError => e
368
+ puts "Exception when calling UsersApi->delete_profile_image: #{e}"
369
+ end
370
+ ```
371
+
372
+ ### Parameters
373
+
374
+ Name | Type | Description | Notes
375
+ ------------- | ------------- | ------------- | -------------
376
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
377
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
378
+
379
+ ### Return type
380
+
381
+ nil (empty response body)
382
+
383
+ ### Authorization
384
+
385
+ No authorization required
386
+
387
+ ### HTTP request headers
388
+
389
+ - **Content-Type**: Not defined
390
+ - **Accept**: application/json
391
+
392
+
393
+
394
+ # **delete_signature**
395
+ > delete_signature(account_id, signature_id, user_id)
396
+
397
+ Removes removes signature information for the specified user.
398
+
399
+ Removes the signature information for the user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
400
+
401
+ ### Example
402
+ ```ruby
403
+ # load the gem
404
+ require 'docusign_esign'
405
+
406
+ api_instance = DocuSign_eSign::UsersApi.new
407
+
408
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
409
+
410
+ signature_id = "signature_id_example" # String | The ID of the signature being accessed.
411
+
412
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
413
+
414
+
415
+ begin
416
+ #Removes removes signature information for the specified user.
417
+ api_instance.delete_signature(account_id, signature_id, user_id)
418
+ rescue DocuSign_eSign::ApiError => e
419
+ puts "Exception when calling UsersApi->delete_signature: #{e}"
420
+ end
421
+ ```
422
+
423
+ ### Parameters
424
+
425
+ Name | Type | Description | Notes
426
+ ------------- | ------------- | ------------- | -------------
427
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
428
+ **signature_id** | **String**| The ID of the signature being accessed. |
429
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
430
+
431
+ ### Return type
432
+
433
+ nil (empty response body)
434
+
435
+ ### Authorization
436
+
437
+ No authorization required
438
+
439
+ ### HTTP request headers
440
+
441
+ - **Content-Type**: Not defined
442
+ - **Accept**: application/json
443
+
444
+
445
+
446
+ # **delete_signature_image**
447
+ > UserSignature delete_signature_image(account_id, image_type, signature_id, user_id)
448
+
449
+ Deletes the user initials image or the user signature image for the specified user.
450
+
451
+ Deletes the specified initials image or signature image for the specified user. The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
452
+
453
+ ### Example
454
+ ```ruby
455
+ # load the gem
456
+ require 'docusign_esign'
457
+
458
+ api_instance = DocuSign_eSign::UsersApi.new
459
+
460
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
461
+
462
+ image_type = "image_type_example" # String | One of **signature_image** or **initials_image**.
463
+
464
+ signature_id = "signature_id_example" # String | The ID of the signature being accessed.
465
+
466
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
467
+
468
+
469
+ begin
470
+ #Deletes the user initials image or the user signature image for the specified user.
471
+ result = api_instance.delete_signature_image(account_id, image_type, signature_id, user_id)
472
+ p result
473
+ rescue DocuSign_eSign::ApiError => e
474
+ puts "Exception when calling UsersApi->delete_signature_image: #{e}"
475
+ end
476
+ ```
477
+
478
+ ### Parameters
479
+
480
+ Name | Type | Description | Notes
481
+ ------------- | ------------- | ------------- | -------------
482
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
483
+ **image_type** | **String**| One of **signature_image** or **initials_image**. |
484
+ **signature_id** | **String**| The ID of the signature being accessed. |
485
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
486
+
487
+ ### Return type
488
+
489
+ [**UserSignature**](UserSignature.md)
490
+
491
+ ### Authorization
492
+
493
+ No authorization required
494
+
495
+ ### HTTP request headers
496
+
497
+ - **Content-Type**: Not defined
498
+ - **Accept**: application/json
499
+
500
+
501
+
502
+ # **get_contact_by_id**
503
+ > ContactGetResponse get_contact_by_id(account_id, contact_id)
504
+
505
+ Gets a particular contact associated with the user's account.
506
+
507
+ ### Example
508
+ ```ruby
509
+ # load the gem
510
+ require 'docusign_esign'
511
+
512
+ api_instance = DocuSign_eSign::UsersApi.new
513
+
514
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
515
+
516
+ contact_id = "contact_id_example" # String | The unique identifier of a person in the contacts address book.
517
+
518
+
519
+ begin
520
+ #Gets a particular contact associated with the user's account.
521
+ result = api_instance.get_contact_by_id(account_id, contact_id)
522
+ p result
523
+ rescue DocuSign_eSign::ApiError => e
524
+ puts "Exception when calling UsersApi->get_contact_by_id: #{e}"
525
+ end
526
+ ```
527
+
528
+ ### Parameters
529
+
530
+ Name | Type | Description | Notes
531
+ ------------- | ------------- | ------------- | -------------
532
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
533
+ **contact_id** | **String**| The unique identifier of a person in the contacts address book. |
534
+
535
+ ### Return type
536
+
537
+ [**ContactGetResponse**](ContactGetResponse.md)
538
+
539
+ ### Authorization
540
+
541
+ No authorization required
542
+
543
+ ### HTTP request headers
544
+
545
+ - **Content-Type**: Not defined
546
+ - **Accept**: application/json
547
+
548
+
549
+
550
+ # **get_information**
551
+ > UserInformation get_information(account_id, user_id, opts)
552
+
553
+ Gets the user information for a specified user.
554
+
555
+ Retrieves the user information for the specified user. To return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to **true**.
556
+
557
+ ### Example
558
+ ```ruby
559
+ # load the gem
560
+ require 'docusign_esign'
561
+
562
+ api_instance = DocuSign_eSign::UsersApi.new
563
+
564
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
565
+
566
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
567
+
568
+ opts = {
569
+ additional_info: "additional_info_example", # String | When set to **true**, the full list of user information is returned for each user in the account.
570
+ email: "email_example" # String |
571
+ }
572
+
573
+ begin
574
+ #Gets the user information for a specified user.
575
+ result = api_instance.get_information(account_id, user_id, opts)
576
+ p result
577
+ rescue DocuSign_eSign::ApiError => e
578
+ puts "Exception when calling UsersApi->get_information: #{e}"
579
+ end
580
+ ```
581
+
582
+ ### Parameters
583
+
584
+ Name | Type | Description | Notes
585
+ ------------- | ------------- | ------------- | -------------
586
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
587
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
588
+ **additional_info** | **String**| When set to **true**, the full list of user information is returned for each user in the account. | [optional]
589
+ **email** | **String**| | [optional]
590
+
591
+ ### Return type
592
+
593
+ [**UserInformation**](UserInformation.md)
594
+
595
+ ### Authorization
596
+
597
+ No authorization required
598
+
599
+ ### HTTP request headers
600
+
601
+ - **Content-Type**: Not defined
602
+ - **Accept**: application/json
603
+
604
+
605
+
606
+ # **get_profile**
607
+ > UserProfile get_profile(account_id, user_id)
608
+
609
+ Retrieves the user profile for a specified user.
610
+
611
+ Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.
612
+
613
+ ### Example
614
+ ```ruby
615
+ # load the gem
616
+ require 'docusign_esign'
617
+
618
+ api_instance = DocuSign_eSign::UsersApi.new
619
+
620
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
621
+
622
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
623
+
624
+
625
+ begin
626
+ #Retrieves the user profile for a specified user.
627
+ result = api_instance.get_profile(account_id, user_id)
628
+ p result
629
+ rescue DocuSign_eSign::ApiError => e
630
+ puts "Exception when calling UsersApi->get_profile: #{e}"
631
+ end
632
+ ```
633
+
634
+ ### Parameters
635
+
636
+ Name | Type | Description | Notes
637
+ ------------- | ------------- | ------------- | -------------
638
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
639
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
640
+
641
+ ### Return type
642
+
643
+ [**UserProfile**](UserProfile.md)
644
+
645
+ ### Authorization
646
+
647
+ No authorization required
648
+
649
+ ### HTTP request headers
650
+
651
+ - **Content-Type**: Not defined
652
+ - **Accept**: application/json
653
+
654
+
655
+
656
+ # **get_profile_image**
657
+ > File get_profile_image(account_id, user_id, opts)
658
+
659
+ Retrieves the user profile image for the specified user.
660
+
661
+ Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account. If successful, the response returns a 200 - OK and the user profile image.
662
+
663
+ ### Example
664
+ ```ruby
665
+ # load the gem
666
+ require 'docusign_esign'
667
+
668
+ api_instance = DocuSign_eSign::UsersApi.new
669
+
670
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
671
+
672
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
673
+
674
+ opts = {
675
+ encoding: "encoding_example" # String |
676
+ }
677
+
678
+ begin
679
+ #Retrieves the user profile image for the specified user.
680
+ result = api_instance.get_profile_image(account_id, user_id, opts)
681
+ p result
682
+ rescue DocuSign_eSign::ApiError => e
683
+ puts "Exception when calling UsersApi->get_profile_image: #{e}"
684
+ end
685
+ ```
686
+
687
+ ### Parameters
688
+
689
+ Name | Type | Description | Notes
690
+ ------------- | ------------- | ------------- | -------------
691
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
692
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
693
+ **encoding** | **String**| | [optional]
694
+
695
+ ### Return type
696
+
697
+ **File**
698
+
699
+ ### Authorization
700
+
701
+ No authorization required
702
+
703
+ ### HTTP request headers
704
+
705
+ - **Content-Type**: Not defined
706
+ - **Accept**: image/gif
707
+
708
+
709
+
710
+ # **get_settings**
711
+ > UserSettingsInformation get_settings(account_id, user_id)
712
+
713
+ Gets the user account settings for a specified user.
714
+
715
+ Retrieves a list of the account settings and email notification information for the specified user. The response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see the [ML:userSettings list].
716
+
717
+ ### Example
718
+ ```ruby
719
+ # load the gem
720
+ require 'docusign_esign'
721
+
722
+ api_instance = DocuSign_eSign::UsersApi.new
723
+
724
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
725
+
726
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
727
+
728
+
729
+ begin
730
+ #Gets the user account settings for a specified user.
731
+ result = api_instance.get_settings(account_id, user_id)
732
+ p result
733
+ rescue DocuSign_eSign::ApiError => e
734
+ puts "Exception when calling UsersApi->get_settings: #{e}"
735
+ end
736
+ ```
737
+
738
+ ### Parameters
739
+
740
+ Name | Type | Description | Notes
741
+ ------------- | ------------- | ------------- | -------------
742
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
743
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
744
+
745
+ ### Return type
746
+
747
+ [**UserSettingsInformation**](UserSettingsInformation.md)
748
+
749
+ ### Authorization
750
+
751
+ No authorization required
752
+
753
+ ### HTTP request headers
754
+
755
+ - **Content-Type**: Not defined
756
+ - **Accept**: application/json
757
+
758
+
759
+
760
+ # **get_signature**
761
+ > UserSignature get_signature(account_id, signature_id, user_id)
762
+
763
+ Gets the user signature information for the specified user.
764
+
765
+ Retrieves the structure of a single signature with a known signature name. 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 `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
766
+
767
+ ### Example
768
+ ```ruby
769
+ # load the gem
770
+ require 'docusign_esign'
771
+
772
+ api_instance = DocuSign_eSign::UsersApi.new
773
+
774
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
775
+
776
+ signature_id = "signature_id_example" # String | The ID of the signature being accessed.
777
+
778
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
779
+
780
+
781
+ begin
782
+ #Gets the user signature information for the specified user.
783
+ result = api_instance.get_signature(account_id, signature_id, user_id)
784
+ p result
785
+ rescue DocuSign_eSign::ApiError => e
786
+ puts "Exception when calling UsersApi->get_signature: #{e}"
787
+ end
788
+ ```
789
+
790
+ ### Parameters
791
+
792
+ Name | Type | Description | Notes
793
+ ------------- | ------------- | ------------- | -------------
794
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
795
+ **signature_id** | **String**| The ID of the signature being accessed. |
796
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
797
+
798
+ ### Return type
799
+
800
+ [**UserSignature**](UserSignature.md)
801
+
802
+ ### Authorization
803
+
804
+ No authorization required
805
+
806
+ ### HTTP request headers
807
+
808
+ - **Content-Type**: Not defined
809
+ - **Accept**: application/json
810
+
811
+
812
+
813
+ # **get_signature_image**
814
+ > File get_signature_image(account_id, image_type, signature_id, user_id, opts)
815
+
816
+ Retrieves the user initials image or the user signature image for the specified user.
817
+
818
+ Retrieves the specified initials image or signature image for the specified user. 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 property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\". ###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
819
+
820
+ ### Example
821
+ ```ruby
822
+ # load the gem
823
+ require 'docusign_esign'
824
+
825
+ api_instance = DocuSign_eSign::UsersApi.new
826
+
827
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
828
+
829
+ image_type = "image_type_example" # String | One of **signature_image** or **initials_image**.
830
+
831
+ signature_id = "signature_id_example" # String | The ID of the signature being accessed.
832
+
833
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
834
+
835
+ opts = {
836
+ include_chrome: "include_chrome_example" # String |
837
+ }
838
+
839
+ begin
840
+ #Retrieves the user initials image or the user signature image for the specified user.
841
+ result = api_instance.get_signature_image(account_id, image_type, signature_id, user_id, opts)
842
+ p result
843
+ rescue DocuSign_eSign::ApiError => e
844
+ puts "Exception when calling UsersApi->get_signature_image: #{e}"
845
+ end
846
+ ```
847
+
848
+ ### Parameters
849
+
850
+ Name | Type | Description | Notes
851
+ ------------- | ------------- | ------------- | -------------
852
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
853
+ **image_type** | **String**| One of **signature_image** or **initials_image**. |
854
+ **signature_id** | **String**| The ID of the signature being accessed. |
855
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
856
+ **include_chrome** | **String**| | [optional]
857
+
858
+ ### Return type
859
+
860
+ **File**
861
+
862
+ ### Authorization
863
+
864
+ No authorization required
865
+
866
+ ### HTTP request headers
867
+
868
+ - **Content-Type**: Not defined
869
+ - **Accept**: image/gif
870
+
871
+
872
+
873
+ # **list**
874
+ > UserInformationList list(account_id, opts)
875
+
876
+ Retrieves the list of users for the specified account.
877
+
878
+ Retrieves the list of users for the specified account. The response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to **true**, the full user information is returned for each user
879
+
880
+ ### Example
881
+ ```ruby
882
+ # load the gem
883
+ require 'docusign_esign'
884
+
885
+ api_instance = DocuSign_eSign::UsersApi.new
886
+
887
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
888
+
889
+ opts = {
890
+ additional_info: "additional_info_example", # String | When set to **true**, the full list of user information is returned for each user in the account.
891
+ count: "count_example", # String | Number of records to return. The number must be greater than 0 and less than or equal to 100.
892
+ email: "email_example", # String |
893
+ email_substring: "email_substring_example", # String | Filters the returned user records by the email address or a sub-string of email address.
894
+ group_id: "group_id_example", # String | Filters user records returned by one or more group Id's.
895
+ include_usersettings_for_csv: "include_usersettings_for_csv_example", # String |
896
+ login_status: "login_status_example", # String |
897
+ not_group_id: "not_group_id_example", # String |
898
+ start_position: "start_position_example", # String | Starting value for the list.
899
+ status: "status_example", # String |
900
+ user_name_substring: "user_name_substring_example" # String | Filters the user records returned by the user name or a sub-string of user name.
901
+ }
902
+
903
+ begin
904
+ #Retrieves the list of users for the specified account.
905
+ result = api_instance.list(account_id, opts)
906
+ p result
907
+ rescue DocuSign_eSign::ApiError => e
908
+ puts "Exception when calling UsersApi->list: #{e}"
909
+ end
910
+ ```
911
+
912
+ ### Parameters
913
+
914
+ Name | Type | Description | Notes
915
+ ------------- | ------------- | ------------- | -------------
916
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
917
+ **additional_info** | **String**| When set to **true**, the full list of user information is returned for each user in the account. | [optional]
918
+ **count** | **String**| Number of records to return. The number must be greater than 0 and less than or equal to 100. | [optional]
919
+ **email** | **String**| | [optional]
920
+ **email_substring** | **String**| Filters the returned user records by the email address or a sub-string of email address. | [optional]
921
+ **group_id** | **String**| Filters user records returned by one or more group Id's. | [optional]
922
+ **include_usersettings_for_csv** | **String**| | [optional]
923
+ **login_status** | **String**| | [optional]
924
+ **not_group_id** | **String**| | [optional]
925
+ **start_position** | **String**| Starting value for the list. | [optional]
926
+ **status** | **String**| | [optional]
927
+ **user_name_substring** | **String**| Filters the user records returned by the user name or a sub-string of user name. | [optional]
928
+
929
+ ### Return type
930
+
931
+ [**UserInformationList**](UserInformationList.md)
932
+
933
+ ### Authorization
934
+
935
+ No authorization required
936
+
937
+ ### HTTP request headers
938
+
939
+ - **Content-Type**: Not defined
940
+ - **Accept**: application/json
941
+
942
+
943
+
944
+ # **list_custom_settings**
945
+ > CustomSettingsInformation list_custom_settings(account_id, user_id)
946
+
947
+ Retrieves the custom user settings for a specified user.
948
+
949
+ Retrieves a list of custom user settings for a single user. Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system. ###### Note: Custom user settings are not the same as user account settings. ###Getting Grouped Custom User Settings### If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are retrieved.
950
+
951
+ ### Example
952
+ ```ruby
953
+ # load the gem
954
+ require 'docusign_esign'
955
+
956
+ api_instance = DocuSign_eSign::UsersApi.new
957
+
958
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
959
+
960
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
961
+
962
+
963
+ begin
964
+ #Retrieves the custom user settings for a specified user.
965
+ result = api_instance.list_custom_settings(account_id, user_id)
966
+ p result
967
+ rescue DocuSign_eSign::ApiError => e
968
+ puts "Exception when calling UsersApi->list_custom_settings: #{e}"
969
+ end
970
+ ```
971
+
972
+ ### Parameters
973
+
974
+ Name | Type | Description | Notes
975
+ ------------- | ------------- | ------------- | -------------
976
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
977
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
978
+
979
+ ### Return type
980
+
981
+ [**CustomSettingsInformation**](CustomSettingsInformation.md)
982
+
983
+ ### Authorization
984
+
985
+ No authorization required
986
+
987
+ ### HTTP request headers
988
+
989
+ - **Content-Type**: Not defined
990
+ - **Accept**: application/json
991
+
992
+
993
+
994
+ # **list_signatures**
995
+ > UserSignaturesInformation list_signatures(account_id, user_id)
996
+
997
+ Retrieves a list of user signature definitions for a specified user.
998
+
999
+ Retrieves the signature definitions for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
1000
+
1001
+ ### Example
1002
+ ```ruby
1003
+ # load the gem
1004
+ require 'docusign_esign'
1005
+
1006
+ api_instance = DocuSign_eSign::UsersApi.new
1007
+
1008
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1009
+
1010
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
1011
+
1012
+
1013
+ begin
1014
+ #Retrieves a list of user signature definitions for a specified user.
1015
+ result = api_instance.list_signatures(account_id, user_id)
1016
+ p result
1017
+ rescue DocuSign_eSign::ApiError => e
1018
+ puts "Exception when calling UsersApi->list_signatures: #{e}"
1019
+ end
1020
+ ```
1021
+
1022
+ ### Parameters
1023
+
1024
+ Name | Type | Description | Notes
1025
+ ------------- | ------------- | ------------- | -------------
1026
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1027
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
1028
+
1029
+ ### Return type
1030
+
1031
+ [**UserSignaturesInformation**](UserSignaturesInformation.md)
1032
+
1033
+ ### Authorization
1034
+
1035
+ No authorization required
1036
+
1037
+ ### HTTP request headers
1038
+
1039
+ - **Content-Type**: Not defined
1040
+ - **Accept**: application/json
1041
+
1042
+
1043
+
1044
+ # **post_contacts**
1045
+ > ContactUpdateResponse post_contacts(account_id, opts)
1046
+
1047
+ Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
1048
+
1049
+ ### Example
1050
+ ```ruby
1051
+ # load the gem
1052
+ require 'docusign_esign'
1053
+
1054
+ api_instance = DocuSign_eSign::UsersApi.new
1055
+
1056
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1057
+
1058
+ opts = {
1059
+ contact_mod_request: DocuSign_eSign::ContactModRequest.new # ContactModRequest |
1060
+ }
1061
+
1062
+ begin
1063
+ #Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
1064
+ result = api_instance.post_contacts(account_id, opts)
1065
+ p result
1066
+ rescue DocuSign_eSign::ApiError => e
1067
+ puts "Exception when calling UsersApi->post_contacts: #{e}"
1068
+ end
1069
+ ```
1070
+
1071
+ ### Parameters
1072
+
1073
+ Name | Type | Description | Notes
1074
+ ------------- | ------------- | ------------- | -------------
1075
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1076
+ **contact_mod_request** | [**ContactModRequest**](ContactModRequest.md)| | [optional]
1077
+
1078
+ ### Return type
1079
+
1080
+ [**ContactUpdateResponse**](ContactUpdateResponse.md)
1081
+
1082
+ ### Authorization
1083
+
1084
+ No authorization required
1085
+
1086
+ ### HTTP request headers
1087
+
1088
+ - **Content-Type**: Not defined
1089
+ - **Accept**: application/json
1090
+
1091
+
1092
+
1093
+ # **put_contacts**
1094
+ > ContactUpdateResponse put_contacts(account_id, opts)
1095
+
1096
+ Replaces contacts associated with an account for the DocuSign service.
1097
+
1098
+ ### Example
1099
+ ```ruby
1100
+ # load the gem
1101
+ require 'docusign_esign'
1102
+
1103
+ api_instance = DocuSign_eSign::UsersApi.new
1104
+
1105
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1106
+
1107
+ opts = {
1108
+ contact_mod_request: DocuSign_eSign::ContactModRequest.new # ContactModRequest |
1109
+ }
1110
+
1111
+ begin
1112
+ #Replaces contacts associated with an account for the DocuSign service.
1113
+ result = api_instance.put_contacts(account_id, opts)
1114
+ p result
1115
+ rescue DocuSign_eSign::ApiError => e
1116
+ puts "Exception when calling UsersApi->put_contacts: #{e}"
1117
+ end
1118
+ ```
1119
+
1120
+ ### Parameters
1121
+
1122
+ Name | Type | Description | Notes
1123
+ ------------- | ------------- | ------------- | -------------
1124
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1125
+ **contact_mod_request** | [**ContactModRequest**](ContactModRequest.md)| | [optional]
1126
+
1127
+ ### Return type
1128
+
1129
+ [**ContactUpdateResponse**](ContactUpdateResponse.md)
1130
+
1131
+ ### Authorization
1132
+
1133
+ No authorization required
1134
+
1135
+ ### HTTP request headers
1136
+
1137
+ - **Content-Type**: Not defined
1138
+ - **Accept**: application/json
1139
+
1140
+
1141
+
1142
+ # **update_custom_settings**
1143
+ > CustomSettingsInformation update_custom_settings(account_id, user_id, opts)
1144
+
1145
+ Adds or updates custom user settings for the specified user.
1146
+
1147
+ Adds or updates custom user settings for the specified user. ###### Note: Custom user settings are not the same as user account settings. Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system. **Important**: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings. ### Grouping Custom User Settings ### You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings. To group custom user settings, add the following information in the header, after Content-Type: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below. When getting or deleting grouped custom user settings, you must include the extra header information. Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.
1148
+
1149
+ ### Example
1150
+ ```ruby
1151
+ # load the gem
1152
+ require 'docusign_esign'
1153
+
1154
+ api_instance = DocuSign_eSign::UsersApi.new
1155
+
1156
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1157
+
1158
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
1159
+
1160
+ opts = {
1161
+ custom_settings_information: DocuSign_eSign::CustomSettingsInformation.new # CustomSettingsInformation |
1162
+ }
1163
+
1164
+ begin
1165
+ #Adds or updates custom user settings for the specified user.
1166
+ result = api_instance.update_custom_settings(account_id, user_id, opts)
1167
+ p result
1168
+ rescue DocuSign_eSign::ApiError => e
1169
+ puts "Exception when calling UsersApi->update_custom_settings: #{e}"
1170
+ end
1171
+ ```
1172
+
1173
+ ### Parameters
1174
+
1175
+ Name | Type | Description | Notes
1176
+ ------------- | ------------- | ------------- | -------------
1177
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1178
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
1179
+ **custom_settings_information** | [**CustomSettingsInformation**](CustomSettingsInformation.md)| | [optional]
1180
+
1181
+ ### Return type
1182
+
1183
+ [**CustomSettingsInformation**](CustomSettingsInformation.md)
1184
+
1185
+ ### Authorization
1186
+
1187
+ No authorization required
1188
+
1189
+ ### HTTP request headers
1190
+
1191
+ - **Content-Type**: Not defined
1192
+ - **Accept**: application/json
1193
+
1194
+
1195
+
1196
+ # **update_profile**
1197
+ > update_profile(account_id, user_id, opts)
1198
+
1199
+ Updates the user profile information for the specified user.
1200
+
1201
+ Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.
1202
+
1203
+ ### Example
1204
+ ```ruby
1205
+ # load the gem
1206
+ require 'docusign_esign'
1207
+
1208
+ api_instance = DocuSign_eSign::UsersApi.new
1209
+
1210
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1211
+
1212
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
1213
+
1214
+ opts = {
1215
+ user_profile: DocuSign_eSign::UserProfile.new # UserProfile |
1216
+ }
1217
+
1218
+ begin
1219
+ #Updates the user profile information for the specified user.
1220
+ api_instance.update_profile(account_id, user_id, opts)
1221
+ rescue DocuSign_eSign::ApiError => e
1222
+ puts "Exception when calling UsersApi->update_profile: #{e}"
1223
+ end
1224
+ ```
1225
+
1226
+ ### Parameters
1227
+
1228
+ Name | Type | Description | Notes
1229
+ ------------- | ------------- | ------------- | -------------
1230
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1231
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
1232
+ **user_profile** | [**UserProfile**](UserProfile.md)| | [optional]
1233
+
1234
+ ### Return type
1235
+
1236
+ nil (empty response body)
1237
+
1238
+ ### Authorization
1239
+
1240
+ No authorization required
1241
+
1242
+ ### HTTP request headers
1243
+
1244
+ - **Content-Type**: Not defined
1245
+ - **Accept**: application/json
1246
+
1247
+
1248
+
1249
+ # **update_profile_image**
1250
+ > update_profile_image(account_id, user_id)
1251
+
1252
+ Updates the user profile image for a specified user.
1253
+
1254
+ Updates the user profile image by uploading an image to the user profile. The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.
1255
+
1256
+ ### Example
1257
+ ```ruby
1258
+ # load the gem
1259
+ require 'docusign_esign'
1260
+
1261
+ api_instance = DocuSign_eSign::UsersApi.new
1262
+
1263
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1264
+
1265
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
1266
+
1267
+
1268
+ begin
1269
+ #Updates the user profile image for a specified user.
1270
+ api_instance.update_profile_image(account_id, user_id)
1271
+ rescue DocuSign_eSign::ApiError => e
1272
+ puts "Exception when calling UsersApi->update_profile_image: #{e}"
1273
+ end
1274
+ ```
1275
+
1276
+ ### Parameters
1277
+
1278
+ Name | Type | Description | Notes
1279
+ ------------- | ------------- | ------------- | -------------
1280
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1281
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
1282
+
1283
+ ### Return type
1284
+
1285
+ nil (empty response body)
1286
+
1287
+ ### Authorization
1288
+
1289
+ No authorization required
1290
+
1291
+ ### HTTP request headers
1292
+
1293
+ - **Content-Type**: Not defined
1294
+ - **Accept**: application/json
1295
+
1296
+
1297
+
1298
+ # **update_settings**
1299
+ > update_settings(account_id, user_id, opts)
1300
+
1301
+ Updates the user account settings for a specified user.
1302
+
1303
+ Updates the account settings list and email notification types for the specified user.
1304
+
1305
+ ### Example
1306
+ ```ruby
1307
+ # load the gem
1308
+ require 'docusign_esign'
1309
+
1310
+ api_instance = DocuSign_eSign::UsersApi.new
1311
+
1312
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1313
+
1314
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
1315
+
1316
+ opts = {
1317
+ user_settings_information: DocuSign_eSign::UserSettingsInformation.new # UserSettingsInformation |
1318
+ }
1319
+
1320
+ begin
1321
+ #Updates the user account settings for a specified user.
1322
+ api_instance.update_settings(account_id, user_id, opts)
1323
+ rescue DocuSign_eSign::ApiError => e
1324
+ puts "Exception when calling UsersApi->update_settings: #{e}"
1325
+ end
1326
+ ```
1327
+
1328
+ ### Parameters
1329
+
1330
+ Name | Type | Description | Notes
1331
+ ------------- | ------------- | ------------- | -------------
1332
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1333
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
1334
+ **user_settings_information** | [**UserSettingsInformation**](UserSettingsInformation.md)| | [optional]
1335
+
1336
+ ### Return type
1337
+
1338
+ nil (empty response body)
1339
+
1340
+ ### Authorization
1341
+
1342
+ No authorization required
1343
+
1344
+ ### HTTP request headers
1345
+
1346
+ - **Content-Type**: Not defined
1347
+ - **Accept**: application/json
1348
+
1349
+
1350
+
1351
+ # **update_signature**
1352
+ > UserSignature update_signature(account_id, signature_id, user_id, opts)
1353
+
1354
+ Updates the user signature for a specified user.
1355
+
1356
+ Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature. ###### Note: This will also create a default signature for the user when one does not exist. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
1357
+
1358
+ ### Example
1359
+ ```ruby
1360
+ # load the gem
1361
+ require 'docusign_esign'
1362
+
1363
+ api_instance = DocuSign_eSign::UsersApi.new
1364
+
1365
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1366
+
1367
+ signature_id = "signature_id_example" # String | The ID of the signature being accessed.
1368
+
1369
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
1370
+
1371
+ opts = {
1372
+ close_existing_signature: "close_existing_signature_example", # String | When set to **true**, closes the current signature.
1373
+ user_signature_definition: DocuSign_eSign::UserSignatureDefinition.new # UserSignatureDefinition |
1374
+ }
1375
+
1376
+ begin
1377
+ #Updates the user signature for a specified user.
1378
+ result = api_instance.update_signature(account_id, signature_id, user_id, opts)
1379
+ p result
1380
+ rescue DocuSign_eSign::ApiError => e
1381
+ puts "Exception when calling UsersApi->update_signature: #{e}"
1382
+ end
1383
+ ```
1384
+
1385
+ ### Parameters
1386
+
1387
+ Name | Type | Description | Notes
1388
+ ------------- | ------------- | ------------- | -------------
1389
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1390
+ **signature_id** | **String**| The ID of the signature being accessed. |
1391
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
1392
+ **close_existing_signature** | **String**| When set to **true**, closes the current signature. | [optional]
1393
+ **user_signature_definition** | [**UserSignatureDefinition**](UserSignatureDefinition.md)| | [optional]
1394
+
1395
+ ### Return type
1396
+
1397
+ [**UserSignature**](UserSignature.md)
1398
+
1399
+ ### Authorization
1400
+
1401
+ No authorization required
1402
+
1403
+ ### HTTP request headers
1404
+
1405
+ - **Content-Type**: Not defined
1406
+ - **Accept**: application/json
1407
+
1408
+
1409
+
1410
+ # **update_signature_image**
1411
+ > UserSignature update_signature_image(account_id, image_type, signature_id, user_id)
1412
+
1413
+ Updates the user signature image or user initials image for the specified user.
1414
+
1415
+ Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode \"Bob Smith\" as \"Bob%20Smith\".
1416
+
1417
+ ### Example
1418
+ ```ruby
1419
+ # load the gem
1420
+ require 'docusign_esign'
1421
+
1422
+ api_instance = DocuSign_eSign::UsersApi.new
1423
+
1424
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1425
+
1426
+ image_type = "image_type_example" # String | One of **signature_image** or **initials_image**.
1427
+
1428
+ signature_id = "signature_id_example" # String | The ID of the signature being accessed.
1429
+
1430
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
1431
+
1432
+
1433
+ begin
1434
+ #Updates the user signature image or user initials image for the specified user.
1435
+ result = api_instance.update_signature_image(account_id, image_type, signature_id, user_id)
1436
+ p result
1437
+ rescue DocuSign_eSign::ApiError => e
1438
+ puts "Exception when calling UsersApi->update_signature_image: #{e}"
1439
+ end
1440
+ ```
1441
+
1442
+ ### Parameters
1443
+
1444
+ Name | Type | Description | Notes
1445
+ ------------- | ------------- | ------------- | -------------
1446
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1447
+ **image_type** | **String**| One of **signature_image** or **initials_image**. |
1448
+ **signature_id** | **String**| The ID of the signature being accessed. |
1449
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
1450
+
1451
+ ### Return type
1452
+
1453
+ [**UserSignature**](UserSignature.md)
1454
+
1455
+ ### Authorization
1456
+
1457
+ No authorization required
1458
+
1459
+ ### HTTP request headers
1460
+
1461
+ - **Content-Type**: Not defined
1462
+ - **Accept**: application/json
1463
+
1464
+
1465
+
1466
+ # **update_user**
1467
+ > UserInformation update_user(account_id, user_id, opts)
1468
+
1469
+ Updates the specified user information.
1470
+
1471
+ ### Example
1472
+ ```ruby
1473
+ # load the gem
1474
+ require 'docusign_esign'
1475
+
1476
+ api_instance = DocuSign_eSign::UsersApi.new
1477
+
1478
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1479
+
1480
+ user_id = "user_id_example" # String | The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
1481
+
1482
+ opts = {
1483
+ user_information: DocuSign_eSign::UserInformation.new # UserInformation |
1484
+ }
1485
+
1486
+ begin
1487
+ #Updates the specified user information.
1488
+ result = api_instance.update_user(account_id, user_id, opts)
1489
+ p result
1490
+ rescue DocuSign_eSign::ApiError => e
1491
+ puts "Exception when calling UsersApi->update_user: #{e}"
1492
+ end
1493
+ ```
1494
+
1495
+ ### Parameters
1496
+
1497
+ Name | Type | Description | Notes
1498
+ ------------- | ------------- | ------------- | -------------
1499
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1500
+ **user_id** | **String**| The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. |
1501
+ **user_information** | [**UserInformation**](UserInformation.md)| | [optional]
1502
+
1503
+ ### Return type
1504
+
1505
+ [**UserInformation**](UserInformation.md)
1506
+
1507
+ ### Authorization
1508
+
1509
+ No authorization required
1510
+
1511
+ ### HTTP request headers
1512
+
1513
+ - **Content-Type**: Not defined
1514
+ - **Accept**: application/json
1515
+
1516
+
1517
+
1518
+ # **update_users**
1519
+ > UserInformationList update_users(account_id, opts)
1520
+
1521
+ Change one or more user in the specified account.
1522
+
1523
+ ### Example
1524
+ ```ruby
1525
+ # load the gem
1526
+ require 'docusign_esign'
1527
+
1528
+ api_instance = DocuSign_eSign::UsersApi.new
1529
+
1530
+ account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
1531
+
1532
+ opts = {
1533
+ user_information_list: DocuSign_eSign::UserInformationList.new # UserInformationList |
1534
+ }
1535
+
1536
+ begin
1537
+ #Change one or more user in the specified account.
1538
+ result = api_instance.update_users(account_id, opts)
1539
+ p result
1540
+ rescue DocuSign_eSign::ApiError => e
1541
+ puts "Exception when calling UsersApi->update_users: #{e}"
1542
+ end
1543
+ ```
1544
+
1545
+ ### Parameters
1546
+
1547
+ Name | Type | Description | Notes
1548
+ ------------- | ------------- | ------------- | -------------
1549
+ **account_id** | **String**| The external account number (int) or account ID Guid. |
1550
+ **user_information_list** | [**UserInformationList**](UserInformationList.md)| | [optional]
1551
+
1552
+ ### Return type
1553
+
1554
+ [**UserInformationList**](UserInformationList.md)
1555
+
1556
+ ### Authorization
1557
+
1558
+ No authorization required
1559
+
1560
+ ### HTTP request headers
1561
+
1562
+ - **Content-Type**: Not defined
1563
+ - **Accept**: application/json
1564
+
1565
+
1566
+