docusign_esign 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (992) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/LICENSE +21 -0
  4. data/README.md +101 -0
  5. data/Rakefile +8 -0
  6. data/docs/AccountAddress.md +19 -0
  7. data/docs/AccountBillingPlan.md +27 -0
  8. data/docs/AccountBillingPlanResponse.md +13 -0
  9. data/docs/AccountInformation.md +38 -0
  10. data/docs/AccountRoleSettings.md +71 -0
  11. data/docs/AccountSettingsInformation.md +8 -0
  12. data/docs/AccountSharedAccess.md +16 -0
  13. data/docs/AccountSignatureProvider.md +14 -0
  14. data/docs/AccountSignatureProviderOption.md +10 -0
  15. data/docs/AccountSignatureProviders.md +8 -0
  16. data/docs/AccountsApi.md +1997 -0
  17. data/docs/AddOn.md +11 -0
  18. data/docs/AddressInformation.md +15 -0
  19. data/docs/AddressInformationInput.md +10 -0
  20. data/docs/AddressInformationV2.md +15 -0
  21. data/docs/Agent.md +49 -0
  22. data/docs/ApiRequestLog.md +11 -0
  23. data/docs/ApiRequestLogsResult.md +8 -0
  24. data/docs/AppStoreProduct.md +9 -0
  25. data/docs/AppStoreReceipt.md +9 -0
  26. data/docs/Approve.md +40 -0
  27. data/docs/Attachment.md +14 -0
  28. data/docs/AuthenticationApi.md +356 -0
  29. data/docs/AuthenticationMethod.md +11 -0
  30. data/docs/AuthenticationStatus.md +24 -0
  31. data/docs/BccEmailAddress.md +9 -0
  32. data/docs/BillingApi.md +569 -0
  33. data/docs/BillingCharge.md +20 -0
  34. data/docs/BillingChargeResponse.md +8 -0
  35. data/docs/BillingDiscount.md +10 -0
  36. data/docs/BillingInvoice.md +17 -0
  37. data/docs/BillingInvoiceItem.md +12 -0
  38. data/docs/BillingInvoicesResponse.md +10 -0
  39. data/docs/BillingInvoicesSummary.md +10 -0
  40. data/docs/BillingPayment.md +10 -0
  41. data/docs/BillingPaymentItem.md +12 -0
  42. data/docs/BillingPaymentRequest.md +8 -0
  43. data/docs/BillingPaymentResponse.md +8 -0
  44. data/docs/BillingPaymentsResponse.md +10 -0
  45. data/docs/BillingPlan.md +22 -0
  46. data/docs/BillingPlanInformation.md +22 -0
  47. data/docs/BillingPlanPreview.md +13 -0
  48. data/docs/BillingPlanResponse.md +9 -0
  49. data/docs/BillingPlanUpdateResponse.md +14 -0
  50. data/docs/BillingPlansResponse.md +8 -0
  51. data/docs/BillingPrice.md +10 -0
  52. data/docs/Brand.md +20 -0
  53. data/docs/BrandEmailContent.md +11 -0
  54. data/docs/BrandLink.md +11 -0
  55. data/docs/BrandLogos.md +10 -0
  56. data/docs/BrandRequest.md +8 -0
  57. data/docs/BrandResourceUrls.md +11 -0
  58. data/docs/BrandResources.md +14 -0
  59. data/docs/BrandResourcesList.md +8 -0
  60. data/docs/BrandsRequest.md +8 -0
  61. data/docs/BrandsResponse.md +10 -0
  62. data/docs/BulkEnvelope.md +16 -0
  63. data/docs/BulkEnvelopeStatus.md +21 -0
  64. data/docs/BulkEnvelopesApi.md +295 -0
  65. data/docs/BulkEnvelopesResponse.md +14 -0
  66. data/docs/BulkRecipient.md +17 -0
  67. data/docs/BulkRecipientSignatureProvider.md +9 -0
  68. data/docs/BulkRecipientTabLabel.md +9 -0
  69. data/docs/BulkRecipientsRequest.md +8 -0
  70. data/docs/BulkRecipientsResponse.md +14 -0
  71. data/docs/BulkRecipientsSummaryResponse.md +11 -0
  72. data/docs/BulkRecipientsUpdateResponse.md +8 -0
  73. data/docs/CaptiveRecipient.md +11 -0
  74. data/docs/CaptiveRecipientInformation.md +8 -0
  75. data/docs/CarbonCopy.md +49 -0
  76. data/docs/CertifiedDelivery.md +49 -0
  77. data/docs/Checkbox.md +37 -0
  78. data/docs/ChunkedUploadPart.md +9 -0
  79. data/docs/ChunkedUploadRequest.md +9 -0
  80. data/docs/ChunkedUploadResponse.md +14 -0
  81. data/docs/CloudStorageApi.md +424 -0
  82. data/docs/CloudStorageProvider.md +12 -0
  83. data/docs/CloudStorageProviders.md +8 -0
  84. data/docs/Company.md +46 -0
  85. data/docs/CompositeTemplate.md +12 -0
  86. data/docs/ConnectApi.md +891 -0
  87. data/docs/ConnectConfigResults.md +9 -0
  88. data/docs/ConnectCustomConfiguration.md +28 -0
  89. data/docs/ConnectDebugLog.md +12 -0
  90. data/docs/ConnectFailureFilter.md +9 -0
  91. data/docs/ConnectFailureResult.md +12 -0
  92. data/docs/ConnectFailureResults.md +8 -0
  93. data/docs/ConnectLog.md +25 -0
  94. data/docs/ConnectLogs.md +11 -0
  95. data/docs/ConsoleViewRequest.md +9 -0
  96. data/docs/ConsumerDisclosure.md +37 -0
  97. data/docs/Contact.md +16 -0
  98. data/docs/ContactGetResponse.md +14 -0
  99. data/docs/ContactModRequest.md +8 -0
  100. data/docs/ContactUpdateResponse.md +8 -0
  101. data/docs/CorrectViewRequest.md +9 -0
  102. data/docs/Country.md +11 -0
  103. data/docs/CreditCardInformation.md +13 -0
  104. data/docs/CreditCardTypes.md +8 -0
  105. data/docs/CurrencyFeatureSetPrice.md +12 -0
  106. data/docs/CurrencyPlanPrice.md +13 -0
  107. data/docs/CustomFieldV2.md +14 -0
  108. data/docs/CustomFields.md +9 -0
  109. data/docs/CustomFieldsEnvelope.md +9 -0
  110. data/docs/CustomSettingsInformation.md +8 -0
  111. data/docs/CustomTabsApi.md +268 -0
  112. data/docs/Date.md +52 -0
  113. data/docs/DateSigned.md +39 -0
  114. data/docs/Decline.md +41 -0
  115. data/docs/DiagnosticsApi.md +321 -0
  116. data/docs/DiagnosticsSettingsInformation.md +10 -0
  117. data/docs/DobInformationInput.md +10 -0
  118. data/docs/Document.md +27 -0
  119. data/docs/DocumentFieldsInformation.md +8 -0
  120. data/docs/DocumentTemplate.md +12 -0
  121. data/docs/DocumentTemplateList.md +8 -0
  122. data/docs/DocumentVisibility.md +12 -0
  123. data/docs/DocumentVisibilityList.md +8 -0
  124. data/docs/ENoteConfiguration.md +12 -0
  125. data/docs/Editor.md +48 -0
  126. data/docs/Email.md +52 -0
  127. data/docs/EmailAddress.md +38 -0
  128. data/docs/EmailSettings.md +10 -0
  129. data/docs/Envelope.md +54 -0
  130. data/docs/EnvelopeAttachment.md +13 -0
  131. data/docs/EnvelopeAttachmentsRequest.md +8 -0
  132. data/docs/EnvelopeAttachmentsResult.md +8 -0
  133. data/docs/EnvelopeAuditEvent.md +8 -0
  134. data/docs/EnvelopeAuditEventResponse.md +8 -0
  135. data/docs/EnvelopeDefinition.md +63 -0
  136. data/docs/EnvelopeDocument.md +24 -0
  137. data/docs/EnvelopeDocumentsResult.md +9 -0
  138. data/docs/EnvelopeEvent.md +9 -0
  139. data/docs/EnvelopeFormData.md +13 -0
  140. data/docs/EnvelopeId.md +38 -0
  141. data/docs/EnvelopeIdsRequest.md +9 -0
  142. data/docs/EnvelopeNotificationRequest.md +10 -0
  143. data/docs/EnvelopeSummary.md +11 -0
  144. data/docs/EnvelopeTemplate.md +56 -0
  145. data/docs/EnvelopeTemplateDefinition.md +22 -0
  146. data/docs/EnvelopeTemplateResult.md +68 -0
  147. data/docs/EnvelopeTemplateResults.md +15 -0
  148. data/docs/EnvelopeTransactionStatus.md +11 -0
  149. data/docs/EnvelopeUpdateSummary.md +15 -0
  150. data/docs/EnvelopesApi.md +4306 -0
  151. data/docs/EnvelopesInformation.md +15 -0
  152. data/docs/ErrorDetails.md +9 -0
  153. data/docs/EventNotification.md +22 -0
  154. data/docs/EventResult.md +11 -0
  155. data/docs/Expirations.md +10 -0
  156. data/docs/ExternalDocServiceErrorDetails.md +10 -0
  157. data/docs/ExternalFile.md +15 -0
  158. data/docs/ExternalFolder.md +17 -0
  159. data/docs/FeatureSet.md +16 -0
  160. data/docs/FileType.md +9 -0
  161. data/docs/FileTypeList.md +8 -0
  162. data/docs/Filter.md +18 -0
  163. data/docs/FirstName.md +38 -0
  164. data/docs/Folder.md +19 -0
  165. data/docs/FolderItem.md +28 -0
  166. data/docs/FolderItemResponse.md +14 -0
  167. data/docs/FolderItemV2.md +27 -0
  168. data/docs/FolderItemsResponse.md +14 -0
  169. data/docs/FoldersApi.md +261 -0
  170. data/docs/FoldersRequest.md +9 -0
  171. data/docs/FoldersResponse.md +8 -0
  172. data/docs/ForgottenPasswordInformation.md +15 -0
  173. data/docs/FormulaTab.md +56 -0
  174. data/docs/FullName.md +38 -0
  175. data/docs/Group.md +13 -0
  176. data/docs/GroupInformation.md +14 -0
  177. data/docs/GroupsApi.md +552 -0
  178. data/docs/IdCheckInformationInput.md +11 -0
  179. data/docs/InPersonSigner.md +62 -0
  180. data/docs/InitialHere.md +34 -0
  181. data/docs/InlineTemplate.md +12 -0
  182. data/docs/IntegratedUserInfoList.md +15 -0
  183. data/docs/Intermediary.md +49 -0
  184. data/docs/LastName.md +38 -0
  185. data/docs/List.md +46 -0
  186. data/docs/ListCustomField.md +15 -0
  187. data/docs/ListItem.md +10 -0
  188. data/docs/LockInformation.md +15 -0
  189. data/docs/LockRequest.md +12 -0
  190. data/docs/LoginAccount.md +18 -0
  191. data/docs/LoginInformation.md +9 -0
  192. data/docs/MatchBox.md +12 -0
  193. data/docs/MemberGroupSharedItem.md +10 -0
  194. data/docs/MemberSharedItems.md +11 -0
  195. data/docs/MergeField.md +12 -0
  196. data/docs/MobileNotifierConfiguration.md +10 -0
  197. data/docs/MobileNotifierConfigurationInformation.md +8 -0
  198. data/docs/Money.md +10 -0
  199. data/docs/NameValue.md +11 -0
  200. data/docs/NewAccountDefinition.md +17 -0
  201. data/docs/NewAccountSummary.md +14 -0
  202. data/docs/NewUser.md +17 -0
  203. data/docs/NewUsersDefinition.md +8 -0
  204. data/docs/NewUsersSummary.md +8 -0
  205. data/docs/NotaryHost.md +47 -0
  206. data/docs/Note.md +42 -0
  207. data/docs/Notification.md +10 -0
  208. data/docs/Number.md +54 -0
  209. data/docs/OauthAccess.md +13 -0
  210. data/docs/OfflineAttributes.md +13 -0
  211. data/docs/Page.md +15 -0
  212. data/docs/PageImages.md +14 -0
  213. data/docs/PageRequest.md +9 -0
  214. data/docs/PaymentDetails.md +12 -0
  215. data/docs/PaymentLineItem.md +11 -0
  216. data/docs/PermissionProfile.md +14 -0
  217. data/docs/PermissionProfileInformation.md +8 -0
  218. data/docs/PlanInformation.md +13 -0
  219. data/docs/PostTransactionsRequest.md +11 -0
  220. data/docs/PostTransactionsResponse.md +9 -0
  221. data/docs/PowerForm.md +31 -0
  222. data/docs/PowerFormFormDataEnvelope.md +9 -0
  223. data/docs/PowerFormFormDataRecipient.md +11 -0
  224. data/docs/PowerFormRecipient.md +20 -0
  225. data/docs/PowerFormSendersResponse.md +14 -0
  226. data/docs/PowerFormsApi.md +419 -0
  227. data/docs/PowerFormsFormDataResponse.md +8 -0
  228. data/docs/PowerFormsRequest.md +8 -0
  229. data/docs/PowerFormsResponse.md +14 -0
  230. data/docs/PropertyMetadata.md +9 -0
  231. data/docs/Province.md +9 -0
  232. data/docs/ProvisioningInformation.md +14 -0
  233. data/docs/PurchasedEnvelopesInformation.md +16 -0
  234. data/docs/Radio.md +25 -0
  235. data/docs/RadioGroup.md +16 -0
  236. data/docs/RecipientAttachment.md +13 -0
  237. data/docs/RecipientDomain.md +11 -0
  238. data/docs/RecipientEmailNotification.md +10 -0
  239. data/docs/RecipientEvent.md +9 -0
  240. data/docs/RecipientFormData.md +15 -0
  241. data/docs/RecipientNamesResponse.md +10 -0
  242. data/docs/RecipientPhoneAuthentication.md +11 -0
  243. data/docs/RecipientSAMLAuthentication.md +8 -0
  244. data/docs/RecipientSMSAuthentication.md +8 -0
  245. data/docs/RecipientSignatureInformation.md +10 -0
  246. data/docs/RecipientSignatureProvider.md +9 -0
  247. data/docs/RecipientSignatureProviderOptions.md +11 -0
  248. data/docs/RecipientUpdateResponse.md +10 -0
  249. data/docs/RecipientViewRequest.md +21 -0
  250. data/docs/Recipients.md +17 -0
  251. data/docs/RecipientsUpdateSummary.md +8 -0
  252. data/docs/ReferralInformation.md +25 -0
  253. data/docs/Reminders.md +10 -0
  254. data/docs/ResourceInformation.md +8 -0
  255. data/docs/ReturnUrlRequest.md +8 -0
  256. data/docs/SamlAssertionAttribute.md +11 -0
  257. data/docs/SeatDiscount.md +10 -0
  258. data/docs/SenderEmailNotifications.md +14 -0
  259. data/docs/ServerTemplate.md +9 -0
  260. data/docs/ServiceInformation.md +13 -0
  261. data/docs/ServiceVersion.md +9 -0
  262. data/docs/SettingsMetadata.md +13 -0
  263. data/docs/SharedItem.md +10 -0
  264. data/docs/SignHere.md +34 -0
  265. data/docs/SignatureProviderRequiredOption.md +9 -0
  266. data/docs/SignatureType.md +9 -0
  267. data/docs/Signer.md +63 -0
  268. data/docs/SignerAttachment.md +34 -0
  269. data/docs/SignerEmailNotifications.md +21 -0
  270. data/docs/SigningGroup.md +17 -0
  271. data/docs/SigningGroupInformation.md +8 -0
  272. data/docs/SigningGroupUser.md +10 -0
  273. data/docs/SigningGroupUsers.md +8 -0
  274. data/docs/SigningGroupsApi.md +485 -0
  275. data/docs/SocialAccountInformation.md +12 -0
  276. data/docs/SocialAuthentication.md +8 -0
  277. data/docs/Ssn.md +52 -0
  278. data/docs/Ssn4InformationInput.md +10 -0
  279. data/docs/Ssn9InformationInput.md +9 -0
  280. data/docs/TabAccountSettings.md +45 -0
  281. data/docs/TabMetadata.md +46 -0
  282. data/docs/TabMetadataList.md +8 -0
  283. data/docs/Tabs.md +32 -0
  284. data/docs/TemplateCustomFields.md +9 -0
  285. data/docs/TemplateDocumentVisibilityList.md +8 -0
  286. data/docs/TemplateDocumentsResult.md +9 -0
  287. data/docs/TemplateInformation.md +8 -0
  288. data/docs/TemplateMatch.md +10 -0
  289. data/docs/TemplateNotificationRequest.md +11 -0
  290. data/docs/TemplateRecipients.md +17 -0
  291. data/docs/TemplateRole.md +19 -0
  292. data/docs/TemplateSharedItem.md +14 -0
  293. data/docs/TemplateSummary.md +14 -0
  294. data/docs/TemplateTabs.md +32 -0
  295. data/docs/TemplateUpdateSummary.md +15 -0
  296. data/docs/TemplatesApi.md +2349 -0
  297. data/docs/Text.md +55 -0
  298. data/docs/TextCustomField.md +14 -0
  299. data/docs/Title.md +46 -0
  300. data/docs/UsageHistory.md +11 -0
  301. data/docs/UserAccountManagementGranularInformation.md +15 -0
  302. data/docs/UserInfo.md +17 -0
  303. data/docs/UserInfoList.md +8 -0
  304. data/docs/UserInformation.md +41 -0
  305. data/docs/UserInformationList.md +14 -0
  306. data/docs/UserPasswordInformation.md +11 -0
  307. data/docs/UserProfile.md +19 -0
  308. data/docs/UserSettingsInformation.md +11 -0
  309. data/docs/UserSharedItem.md +10 -0
  310. data/docs/UserSignature.md +20 -0
  311. data/docs/UserSignatureDefinition.md +11 -0
  312. data/docs/UserSignaturesInformation.md +8 -0
  313. data/docs/UserSocialIdResult.md +9 -0
  314. data/docs/UsersApi.md +1566 -0
  315. data/docs/UsersResponse.md +14 -0
  316. data/docs/View.md +42 -0
  317. data/docs/ViewLinkRequest.md +9 -0
  318. data/docs/ViewUrl.md +8 -0
  319. data/docs/Workspace.md +18 -0
  320. data/docs/WorkspaceFolderContents.md +15 -0
  321. data/docs/WorkspaceItem.md +26 -0
  322. data/docs/WorkspaceItemList.md +8 -0
  323. data/docs/WorkspaceList.md +12 -0
  324. data/docs/WorkspaceUser.md +23 -0
  325. data/docs/WorkspaceUserAuthorization.md +18 -0
  326. data/docs/WorkspacesApi.md +630 -0
  327. data/docs/Zip.md +53 -0
  328. data/docusign_esign-1.0.0.gem +0 -0
  329. data/docusign_esign.gemspec +47 -0
  330. data/git_push.sh +55 -0
  331. data/lib/docusign_esign/.DS_Store +0 -0
  332. data/lib/docusign_esign/api/accounts_api.rb +2230 -0
  333. data/lib/docusign_esign/api/authentication_api.rb +393 -0
  334. data/lib/docusign_esign/api/billing_api.rb +636 -0
  335. data/lib/docusign_esign/api/bulk_envelopes_api.rb +355 -0
  336. data/lib/docusign_esign/api/cloud_storage_api.rb +507 -0
  337. data/lib/docusign_esign/api/connect_api.rb +967 -0
  338. data/lib/docusign_esign/api/custom_tabs_api.rb +296 -0
  339. data/lib/docusign_esign/api/diagnostics_api.rb +356 -0
  340. data/lib/docusign_esign/api/envelopes_api.rb +4737 -0
  341. data/lib/docusign_esign/api/folders_api.rb +342 -0
  342. data/lib/docusign_esign/api/groups_api.rb +596 -0
  343. data/lib/docusign_esign/api/power_forms_api.rb +489 -0
  344. data/lib/docusign_esign/api/signing_groups_api.rb +513 -0
  345. data/lib/docusign_esign/api/templates_api.rb +2555 -0
  346. data/lib/docusign_esign/api/users_api.rb +1694 -0
  347. data/lib/docusign_esign/api/workspaces_api.rb +719 -0
  348. data/lib/docusign_esign/api_client.rb +421 -0
  349. data/lib/docusign_esign/api_error.rb +37 -0
  350. data/lib/docusign_esign/configuration.rb +195 -0
  351. data/lib/docusign_esign/models/account_address.rb +300 -0
  352. data/lib/docusign_esign/models/account_billing_plan.rb +384 -0
  353. data/lib/docusign_esign/models/account_billing_plan_response.rb +236 -0
  354. data/lib/docusign_esign/models/account_information.rb +488 -0
  355. data/lib/docusign_esign/models/account_role_settings.rb +786 -0
  356. data/lib/docusign_esign/models/account_settings_information.rb +190 -0
  357. data/lib/docusign_esign/models/account_shared_access.rb +269 -0
  358. data/lib/docusign_esign/models/account_signature_provider.rb +252 -0
  359. data/lib/docusign_esign/models/account_signature_provider_option.rb +208 -0
  360. data/lib/docusign_esign/models/account_signature_providers.rb +190 -0
  361. data/lib/docusign_esign/models/add_on.rb +218 -0
  362. data/lib/docusign_esign/models/address_information.rb +258 -0
  363. data/lib/docusign_esign/models/address_information_input.rb +207 -0
  364. data/lib/docusign_esign/models/address_information_v2.rb +258 -0
  365. data/lib/docusign_esign/models/agent.rb +603 -0
  366. data/lib/docusign_esign/models/api_request_log.rb +218 -0
  367. data/lib/docusign_esign/models/api_request_logs_result.rb +190 -0
  368. data/lib/docusign_esign/models/app_store_product.rb +198 -0
  369. data/lib/docusign_esign/models/app_store_receipt.rb +198 -0
  370. data/lib/docusign_esign/models/approve.rb +506 -0
  371. data/lib/docusign_esign/models/attachment.rb +248 -0
  372. data/lib/docusign_esign/models/authentication_method.rb +218 -0
  373. data/lib/docusign_esign/models/authentication_status.rb +331 -0
  374. data/lib/docusign_esign/models/bcc_email_address.rb +198 -0
  375. data/lib/docusign_esign/models/billing_charge.rb +312 -0
  376. data/lib/docusign_esign/models/billing_charge_response.rb +190 -0
  377. data/lib/docusign_esign/models/billing_discount.rb +208 -0
  378. data/lib/docusign_esign/models/billing_invoice.rb +280 -0
  379. data/lib/docusign_esign/models/billing_invoice_item.rb +228 -0
  380. data/lib/docusign_esign/models/billing_invoices_response.rb +210 -0
  381. data/lib/docusign_esign/models/billing_invoices_summary.rb +210 -0
  382. data/lib/docusign_esign/models/billing_payment.rb +208 -0
  383. data/lib/docusign_esign/models/billing_payment_item.rb +228 -0
  384. data/lib/docusign_esign/models/billing_payment_request.rb +188 -0
  385. data/lib/docusign_esign/models/billing_payment_response.rb +190 -0
  386. data/lib/docusign_esign/models/billing_payments_response.rb +210 -0
  387. data/lib/docusign_esign/models/billing_plan.rb +336 -0
  388. data/lib/docusign_esign/models/billing_plan_information.rb +323 -0
  389. data/lib/docusign_esign/models/billing_plan_preview.rb +237 -0
  390. data/lib/docusign_esign/models/billing_plan_response.rb +199 -0
  391. data/lib/docusign_esign/models/billing_plan_update_response.rb +247 -0
  392. data/lib/docusign_esign/models/billing_plans_response.rb +190 -0
  393. data/lib/docusign_esign/models/billing_price.rb +208 -0
  394. data/lib/docusign_esign/models/brand.rb +313 -0
  395. data/lib/docusign_esign/models/brand_email_content.rb +218 -0
  396. data/lib/docusign_esign/models/brand_link.rb +218 -0
  397. data/lib/docusign_esign/models/brand_logos.rb +208 -0
  398. data/lib/docusign_esign/models/brand_request.rb +188 -0
  399. data/lib/docusign_esign/models/brand_resource_urls.rb +218 -0
  400. data/lib/docusign_esign/models/brand_resources.rb +248 -0
  401. data/lib/docusign_esign/models/brand_resources_list.rb +190 -0
  402. data/lib/docusign_esign/models/brands_request.rb +190 -0
  403. data/lib/docusign_esign/models/brands_response.rb +210 -0
  404. data/lib/docusign_esign/models/bulk_envelope.rb +267 -0
  405. data/lib/docusign_esign/models/bulk_envelope_status.rb +320 -0
  406. data/lib/docusign_esign/models/bulk_envelopes_response.rb +250 -0
  407. data/lib/docusign_esign/models/bulk_recipient.rb +284 -0
  408. data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +198 -0
  409. data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +198 -0
  410. data/lib/docusign_esign/models/bulk_recipients_request.rb +190 -0
  411. data/lib/docusign_esign/models/bulk_recipients_response.rb +250 -0
  412. data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +222 -0
  413. data/lib/docusign_esign/models/bulk_recipients_update_response.rb +187 -0
  414. data/lib/docusign_esign/models/captive_recipient.rb +217 -0
  415. data/lib/docusign_esign/models/captive_recipient_information.rb +190 -0
  416. data/lib/docusign_esign/models/carbon_copy.rb +603 -0
  417. data/lib/docusign_esign/models/certified_delivery.rb +603 -0
  418. data/lib/docusign_esign/models/checkbox.rb +476 -0
  419. data/lib/docusign_esign/models/chunked_upload_part.rb +198 -0
  420. data/lib/docusign_esign/models/chunked_upload_request.rb +198 -0
  421. data/lib/docusign_esign/models/chunked_upload_response.rb +250 -0
  422. data/lib/docusign_esign/models/cloud_storage_provider.rb +227 -0
  423. data/lib/docusign_esign/models/cloud_storage_providers.rb +190 -0
  424. data/lib/docusign_esign/models/company.rb +566 -0
  425. data/lib/docusign_esign/models/composite_template.rb +231 -0
  426. data/lib/docusign_esign/models/connect_config_results.rb +200 -0
  427. data/lib/docusign_esign/models/connect_custom_configuration.rb +388 -0
  428. data/lib/docusign_esign/models/connect_debug_log.rb +227 -0
  429. data/lib/docusign_esign/models/connect_failure_filter.rb +200 -0
  430. data/lib/docusign_esign/models/connect_failure_result.rb +228 -0
  431. data/lib/docusign_esign/models/connect_failure_results.rb +190 -0
  432. data/lib/docusign_esign/models/connect_log.rb +360 -0
  433. data/lib/docusign_esign/models/connect_logs.rb +222 -0
  434. data/lib/docusign_esign/models/console_view_request.rb +198 -0
  435. data/lib/docusign_esign/models/consumer_disclosure.rb +478 -0
  436. data/lib/docusign_esign/models/contact.rb +269 -0
  437. data/lib/docusign_esign/models/contact_get_response.rb +250 -0
  438. data/lib/docusign_esign/models/contact_mod_request.rb +190 -0
  439. data/lib/docusign_esign/models/contact_update_response.rb +190 -0
  440. data/lib/docusign_esign/models/correct_view_request.rb +198 -0
  441. data/lib/docusign_esign/models/country.rb +220 -0
  442. data/lib/docusign_esign/models/credit_card_information.rb +237 -0
  443. data/lib/docusign_esign/models/credit_card_types.rb +190 -0
  444. data/lib/docusign_esign/models/currency_feature_set_price.rb +228 -0
  445. data/lib/docusign_esign/models/currency_plan_price.rb +237 -0
  446. data/lib/docusign_esign/models/custom_field_v2.rb +247 -0
  447. data/lib/docusign_esign/models/custom_fields.rb +202 -0
  448. data/lib/docusign_esign/models/custom_fields_envelope.rb +202 -0
  449. data/lib/docusign_esign/models/custom_settings_information.rb +190 -0
  450. data/lib/docusign_esign/models/date.rb +626 -0
  451. data/lib/docusign_esign/models/date_signed.rb +496 -0
  452. data/lib/docusign_esign/models/decline.rb +516 -0
  453. data/lib/docusign_esign/models/diagnostics_settings_information.rb +208 -0
  454. data/lib/docusign_esign/models/dob_information_input.rb +208 -0
  455. data/lib/docusign_esign/models/document.rb +382 -0
  456. data/lib/docusign_esign/models/document_fields_information.rb +190 -0
  457. data/lib/docusign_esign/models/document_template.rb +227 -0
  458. data/lib/docusign_esign/models/document_template_list.rb +190 -0
  459. data/lib/docusign_esign/models/document_visibility.rb +227 -0
  460. data/lib/docusign_esign/models/document_visibility_list.rb +190 -0
  461. data/lib/docusign_esign/models/e_note_configuration.rb +228 -0
  462. data/lib/docusign_esign/models/editor.rb +591 -0
  463. data/lib/docusign_esign/models/email.rb +626 -0
  464. data/lib/docusign_esign/models/email_address.rb +486 -0
  465. data/lib/docusign_esign/models/email_settings.rb +210 -0
  466. data/lib/docusign_esign/models/envelope.rb +643 -0
  467. data/lib/docusign_esign/models/envelope_attachment.rb +237 -0
  468. data/lib/docusign_esign/models/envelope_attachments_request.rb +190 -0
  469. data/lib/docusign_esign/models/envelope_attachments_result.rb +190 -0
  470. data/lib/docusign_esign/models/envelope_audit_event.rb +190 -0
  471. data/lib/docusign_esign/models/envelope_audit_event_response.rb +190 -0
  472. data/lib/docusign_esign/models/envelope_definition.rb +740 -0
  473. data/lib/docusign_esign/models/envelope_document.rb +351 -0
  474. data/lib/docusign_esign/models/envelope_documents_result.rb +200 -0
  475. data/lib/docusign_esign/models/envelope_event.rb +198 -0
  476. data/lib/docusign_esign/models/envelope_form_data.rb +242 -0
  477. data/lib/docusign_esign/models/envelope_id.rb +486 -0
  478. data/lib/docusign_esign/models/envelope_ids_request.rb +202 -0
  479. data/lib/docusign_esign/models/envelope_notification_request.rb +206 -0
  480. data/lib/docusign_esign/models/envelope_summary.rb +218 -0
  481. data/lib/docusign_esign/models/envelope_template.rb +664 -0
  482. data/lib/docusign_esign/models/envelope_template_definition.rb +326 -0
  483. data/lib/docusign_esign/models/envelope_template_result.rb +784 -0
  484. data/lib/docusign_esign/models/envelope_template_results.rb +262 -0
  485. data/lib/docusign_esign/models/envelope_transaction_status.rb +217 -0
  486. data/lib/docusign_esign/models/envelope_update_summary.rb +260 -0
  487. data/lib/docusign_esign/models/envelopes_information.rb +262 -0
  488. data/lib/docusign_esign/models/error_details.rb +198 -0
  489. data/lib/docusign_esign/models/event_notification.rb +332 -0
  490. data/lib/docusign_esign/models/event_result.rb +218 -0
  491. data/lib/docusign_esign/models/expirations.rb +208 -0
  492. data/lib/docusign_esign/models/external_doc_service_error_details.rb +208 -0
  493. data/lib/docusign_esign/models/external_file.rb +258 -0
  494. data/lib/docusign_esign/models/external_folder.rb +279 -0
  495. data/lib/docusign_esign/models/feature_set.rb +270 -0
  496. data/lib/docusign_esign/models/file_type.rb +198 -0
  497. data/lib/docusign_esign/models/file_type_list.rb +190 -0
  498. data/lib/docusign_esign/models/filter.rb +288 -0
  499. data/lib/docusign_esign/models/first_name.rb +486 -0
  500. data/lib/docusign_esign/models/folder.rb +298 -0
  501. data/lib/docusign_esign/models/folder_item.rb +390 -0
  502. data/lib/docusign_esign/models/folder_item_response.rb +250 -0
  503. data/lib/docusign_esign/models/folder_item_v2.rb +377 -0
  504. data/lib/docusign_esign/models/folder_items_response.rb +250 -0
  505. data/lib/docusign_esign/models/folders_request.rb +200 -0
  506. data/lib/docusign_esign/models/folders_response.rb +190 -0
  507. data/lib/docusign_esign/models/forgotten_password_information.rb +258 -0
  508. data/lib/docusign_esign/models/formula_tab.rb +665 -0
  509. data/lib/docusign_esign/models/full_name.rb +486 -0
  510. data/lib/docusign_esign/models/group.rb +239 -0
  511. data/lib/docusign_esign/models/group_information.rb +250 -0
  512. data/lib/docusign_esign/models/id_check_information_input.rb +214 -0
  513. data/lib/docusign_esign/models/in_person_signer.rb +729 -0
  514. data/lib/docusign_esign/models/initial_here.rb +446 -0
  515. data/lib/docusign_esign/models/inline_template.rb +227 -0
  516. data/lib/docusign_esign/models/integrated_user_info_list.rb +260 -0
  517. data/lib/docusign_esign/models/intermediary.rb +603 -0
  518. data/lib/docusign_esign/models/last_name.rb +486 -0
  519. data/lib/docusign_esign/models/list.rb +568 -0
  520. data/lib/docusign_esign/models/list_custom_field.rb +259 -0
  521. data/lib/docusign_esign/models/list_item.rb +208 -0
  522. data/lib/docusign_esign/models/lock_information.rb +256 -0
  523. data/lib/docusign_esign/models/lock_request.rb +228 -0
  524. data/lib/docusign_esign/models/login_account.rb +292 -0
  525. data/lib/docusign_esign/models/login_information.rb +200 -0
  526. data/lib/docusign_esign/models/match_box.rb +228 -0
  527. data/lib/docusign_esign/models/member_group_shared_item.rb +206 -0
  528. data/lib/docusign_esign/models/member_shared_items.rb +220 -0
  529. data/lib/docusign_esign/models/merge_field.rb +228 -0
  530. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +207 -0
  531. data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +190 -0
  532. data/lib/docusign_esign/models/money.rb +208 -0
  533. data/lib/docusign_esign/models/name_value.rb +217 -0
  534. data/lib/docusign_esign/models/new_account_definition.rb +274 -0
  535. data/lib/docusign_esign/models/new_account_summary.rb +247 -0
  536. data/lib/docusign_esign/models/new_user.rb +277 -0
  537. data/lib/docusign_esign/models/new_users_definition.rb +190 -0
  538. data/lib/docusign_esign/models/new_users_summary.rb +190 -0
  539. data/lib/docusign_esign/models/notary_host.rb +577 -0
  540. data/lib/docusign_esign/models/note.rb +526 -0
  541. data/lib/docusign_esign/models/notification.rb +206 -0
  542. data/lib/docusign_esign/models/number.rb +646 -0
  543. data/lib/docusign_esign/models/oauth_access.rb +240 -0
  544. data/lib/docusign_esign/models/offline_attributes.rb +238 -0
  545. data/lib/docusign_esign/models/page.rb +257 -0
  546. data/lib/docusign_esign/models/page_images.rb +250 -0
  547. data/lib/docusign_esign/models/page_request.rb +198 -0
  548. data/lib/docusign_esign/models/payment_details.rb +229 -0
  549. data/lib/docusign_esign/models/payment_line_item.rb +218 -0
  550. data/lib/docusign_esign/models/permission_profile.rb +249 -0
  551. data/lib/docusign_esign/models/permission_profile_information.rb +190 -0
  552. data/lib/docusign_esign/models/plan_information.rb +244 -0
  553. data/lib/docusign_esign/models/post_transactions_request.rb +218 -0
  554. data/lib/docusign_esign/models/post_transactions_response.rb +198 -0
  555. data/lib/docusign_esign/models/power_form.rb +421 -0
  556. data/lib/docusign_esign/models/power_form_form_data_envelope.rb +200 -0
  557. data/lib/docusign_esign/models/power_form_form_data_recipient.rb +220 -0
  558. data/lib/docusign_esign/models/power_form_recipient.rb +308 -0
  559. data/lib/docusign_esign/models/power_form_senders_response.rb +250 -0
  560. data/lib/docusign_esign/models/power_forms_form_data_response.rb +190 -0
  561. data/lib/docusign_esign/models/power_forms_request.rb +190 -0
  562. data/lib/docusign_esign/models/power_forms_response.rb +250 -0
  563. data/lib/docusign_esign/models/property_metadata.rb +200 -0
  564. data/lib/docusign_esign/models/province.rb +198 -0
  565. data/lib/docusign_esign/models/provisioning_information.rb +248 -0
  566. data/lib/docusign_esign/models/purchased_envelopes_information.rb +268 -0
  567. data/lib/docusign_esign/models/radio.rb +357 -0
  568. data/lib/docusign_esign/models/radio_group.rb +270 -0
  569. data/lib/docusign_esign/models/recipient_attachment.rb +238 -0
  570. data/lib/docusign_esign/models/recipient_domain.rb +218 -0
  571. data/lib/docusign_esign/models/recipient_email_notification.rb +208 -0
  572. data/lib/docusign_esign/models/recipient_event.rb +198 -0
  573. data/lib/docusign_esign/models/recipient_form_data.rb +260 -0
  574. data/lib/docusign_esign/models/recipient_names_response.rb +210 -0
  575. data/lib/docusign_esign/models/recipient_phone_authentication.rb +220 -0
  576. data/lib/docusign_esign/models/recipient_saml_authentication.rb +190 -0
  577. data/lib/docusign_esign/models/recipient_signature_information.rb +208 -0
  578. data/lib/docusign_esign/models/recipient_signature_provider.rb +197 -0
  579. data/lib/docusign_esign/models/recipient_signature_provider_options.rb +218 -0
  580. data/lib/docusign_esign/models/recipient_sms_authentication.rb +190 -0
  581. data/lib/docusign_esign/models/recipient_update_response.rb +206 -0
  582. data/lib/docusign_esign/models/recipient_view_request.rb +318 -0
  583. data/lib/docusign_esign/models/recipients.rb +291 -0
  584. data/lib/docusign_esign/models/recipients_update_summary.rb +190 -0
  585. data/lib/docusign_esign/models/referral_information.rb +358 -0
  586. data/lib/docusign_esign/models/reminders.rb +208 -0
  587. data/lib/docusign_esign/models/resource_information.rb +190 -0
  588. data/lib/docusign_esign/models/return_url_request.rb +188 -0
  589. data/lib/docusign_esign/models/saml_assertion_attribute.rb +217 -0
  590. data/lib/docusign_esign/models/seat_discount.rb +208 -0
  591. data/lib/docusign_esign/models/sender_email_notifications.rb +248 -0
  592. data/lib/docusign_esign/models/server_template.rb +198 -0
  593. data/lib/docusign_esign/models/service_information.rb +242 -0
  594. data/lib/docusign_esign/models/service_version.rb +198 -0
  595. data/lib/docusign_esign/models/settings_metadata.rb +240 -0
  596. data/lib/docusign_esign/models/shared_item.rb +206 -0
  597. data/lib/docusign_esign/models/sign_here.rb +446 -0
  598. data/lib/docusign_esign/models/signature_provider_required_option.rb +200 -0
  599. data/lib/docusign_esign/models/signature_type.rb +198 -0
  600. data/lib/docusign_esign/models/signer.rb +742 -0
  601. data/lib/docusign_esign/models/signer_attachment.rb +446 -0
  602. data/lib/docusign_esign/models/signer_email_notifications.rb +318 -0
  603. data/lib/docusign_esign/models/signing_group.rb +279 -0
  604. data/lib/docusign_esign/models/signing_group_information.rb +190 -0
  605. data/lib/docusign_esign/models/signing_group_user.rb +207 -0
  606. data/lib/docusign_esign/models/signing_group_users.rb +190 -0
  607. data/lib/docusign_esign/models/social_account_information.rb +227 -0
  608. data/lib/docusign_esign/models/social_authentication.rb +188 -0
  609. data/lib/docusign_esign/models/ssn.rb +626 -0
  610. data/lib/docusign_esign/models/ssn4_information_input.rb +208 -0
  611. data/lib/docusign_esign/models/ssn9_information_input.rb +198 -0
  612. data/lib/docusign_esign/models/tab_account_settings.rb +539 -0
  613. data/lib/docusign_esign/models/tab_metadata.rb +569 -0
  614. data/lib/docusign_esign/models/tab_metadata_list.rb +190 -0
  615. data/lib/docusign_esign/models/tabs.rb +478 -0
  616. data/lib/docusign_esign/models/template_custom_fields.rb +202 -0
  617. data/lib/docusign_esign/models/template_document_visibility_list.rb +190 -0
  618. data/lib/docusign_esign/models/template_documents_result.rb +200 -0
  619. data/lib/docusign_esign/models/template_information.rb +190 -0
  620. data/lib/docusign_esign/models/template_match.rb +208 -0
  621. data/lib/docusign_esign/models/template_notification_request.rb +216 -0
  622. data/lib/docusign_esign/models/template_recipients.rb +291 -0
  623. data/lib/docusign_esign/models/template_role.rb +296 -0
  624. data/lib/docusign_esign/models/template_shared_item.rb +250 -0
  625. data/lib/docusign_esign/models/template_summary.rb +247 -0
  626. data/lib/docusign_esign/models/template_tabs.rb +478 -0
  627. data/lib/docusign_esign/models/template_update_summary.rb +260 -0
  628. data/lib/docusign_esign/models/text.rb +656 -0
  629. data/lib/docusign_esign/models/text_custom_field.rb +247 -0
  630. data/lib/docusign_esign/models/title.rb +566 -0
  631. data/lib/docusign_esign/models/usage_history.rb +218 -0
  632. data/lib/docusign_esign/models/user_account_management_granular_information.rb +254 -0
  633. data/lib/docusign_esign/models/user_info.rb +277 -0
  634. data/lib/docusign_esign/models/user_info_list.rb +190 -0
  635. data/lib/docusign_esign/models/user_information.rb +519 -0
  636. data/lib/docusign_esign/models/user_information_list.rb +250 -0
  637. data/lib/docusign_esign/models/user_password_information.rb +217 -0
  638. data/lib/docusign_esign/models/user_profile.rb +297 -0
  639. data/lib/docusign_esign/models/user_settings_information.rb +217 -0
  640. data/lib/docusign_esign/models/user_shared_item.rb +206 -0
  641. data/lib/docusign_esign/models/user_signature.rb +307 -0
  642. data/lib/docusign_esign/models/user_signature_definition.rb +218 -0
  643. data/lib/docusign_esign/models/user_signatures_information.rb +190 -0
  644. data/lib/docusign_esign/models/user_social_id_result.rb +200 -0
  645. data/lib/docusign_esign/models/users_response.rb +250 -0
  646. data/lib/docusign_esign/models/view.rb +526 -0
  647. data/lib/docusign_esign/models/view_link_request.rb +198 -0
  648. data/lib/docusign_esign/models/view_url.rb +188 -0
  649. data/lib/docusign_esign/models/workspace.rb +286 -0
  650. data/lib/docusign_esign/models/workspace_folder_contents.rb +261 -0
  651. data/lib/docusign_esign/models/workspace_item.rb +365 -0
  652. data/lib/docusign_esign/models/workspace_item_list.rb +190 -0
  653. data/lib/docusign_esign/models/workspace_list.rb +230 -0
  654. data/lib/docusign_esign/models/workspace_user.rb +337 -0
  655. data/lib/docusign_esign/models/workspace_user_authorization.rb +286 -0
  656. data/lib/docusign_esign/models/zip.rb +636 -0
  657. data/lib/docusign_esign/version.rb +14 -0
  658. data/lib/docusign_esign.rb +360 -0
  659. data/spec/api/accounts_api_spec.rb +556 -0
  660. data/spec/api/authentication_api_spec.rb +125 -0
  661. data/spec/api/billing_api_spec.rb +178 -0
  662. data/spec/api/bulk_envelopes_api_spec.rb +110 -0
  663. data/spec/api/cloud_storage_api_spec.rb +146 -0
  664. data/spec/api/connect_api_spec.rb +261 -0
  665. data/spec/api/custom_tabs_api_spec.rb +100 -0
  666. data/spec/api/diagnostics_api_spec.rb +114 -0
  667. data/spec/api/envelopes_api_spec.rb +1171 -0
  668. data/spec/api/folders_api_spec.rb +107 -0
  669. data/spec/api/groups_api_spec.rb +174 -0
  670. data/spec/api/power_forms_api_spec.rb +144 -0
  671. data/spec/api/signing_groups_api_spec.rb +155 -0
  672. data/spec/api/templates_api_spec.rb +649 -0
  673. data/spec/api/users_api_spec.rb +442 -0
  674. data/spec/api/workspaces_api_spec.rb +201 -0
  675. data/spec/api_client_spec.rb +225 -0
  676. data/spec/configuration_spec.rb +41 -0
  677. data/spec/models/account_address_spec.rb +107 -0
  678. data/spec/models/account_billing_plan_response_spec.rb +71 -0
  679. data/spec/models/account_billing_plan_spec.rb +155 -0
  680. data/spec/models/account_information_spec.rb +221 -0
  681. data/spec/models/account_role_settings_spec.rb +419 -0
  682. data/spec/models/account_settings_information_spec.rb +41 -0
  683. data/spec/models/account_shared_access_spec.rb +89 -0
  684. data/spec/models/account_signature_provider_option_spec.rb +53 -0
  685. data/spec/models/account_signature_provider_spec.rb +77 -0
  686. data/spec/models/account_signature_providers_spec.rb +41 -0
  687. data/spec/models/add_on_spec.rb +59 -0
  688. data/spec/models/address_information_input_spec.rb +53 -0
  689. data/spec/models/address_information_spec.rb +83 -0
  690. data/spec/models/address_information_v2_spec.rb +83 -0
  691. data/spec/models/agent_spec.rb +287 -0
  692. data/spec/models/api_request_log_spec.rb +59 -0
  693. data/spec/models/api_request_logs_result_spec.rb +41 -0
  694. data/spec/models/app_store_product_spec.rb +47 -0
  695. data/spec/models/app_store_receipt_spec.rb +47 -0
  696. data/spec/models/approve_spec.rb +233 -0
  697. data/spec/models/attachment_spec.rb +77 -0
  698. data/spec/models/authentication_method_spec.rb +59 -0
  699. data/spec/models/authentication_status_spec.rb +137 -0
  700. data/spec/models/bcc_email_address_spec.rb +47 -0
  701. data/spec/models/billing_charge_response_spec.rb +41 -0
  702. data/spec/models/billing_charge_spec.rb +113 -0
  703. data/spec/models/billing_discount_spec.rb +53 -0
  704. data/spec/models/billing_invoice_item_spec.rb +65 -0
  705. data/spec/models/billing_invoice_spec.rb +95 -0
  706. data/spec/models/billing_invoices_response_spec.rb +53 -0
  707. data/spec/models/billing_invoices_summary_spec.rb +53 -0
  708. data/spec/models/billing_payment_item_spec.rb +65 -0
  709. data/spec/models/billing_payment_request_spec.rb +41 -0
  710. data/spec/models/billing_payment_response_spec.rb +41 -0
  711. data/spec/models/billing_payment_spec.rb +53 -0
  712. data/spec/models/billing_payments_response_spec.rb +53 -0
  713. data/spec/models/billing_plan_information_spec.rb +125 -0
  714. data/spec/models/billing_plan_preview_spec.rb +71 -0
  715. data/spec/models/billing_plan_response_spec.rb +47 -0
  716. data/spec/models/billing_plan_spec.rb +125 -0
  717. data/spec/models/billing_plan_update_response_spec.rb +77 -0
  718. data/spec/models/billing_plans_response_spec.rb +41 -0
  719. data/spec/models/billing_price_spec.rb +53 -0
  720. data/spec/models/brand_email_content_spec.rb +59 -0
  721. data/spec/models/brand_link_spec.rb +59 -0
  722. data/spec/models/brand_logos_spec.rb +53 -0
  723. data/spec/models/brand_request_spec.rb +41 -0
  724. data/spec/models/brand_resource_urls_spec.rb +59 -0
  725. data/spec/models/brand_resources_list_spec.rb +41 -0
  726. data/spec/models/brand_resources_spec.rb +77 -0
  727. data/spec/models/brand_spec.rb +113 -0
  728. data/spec/models/brands_request_spec.rb +41 -0
  729. data/spec/models/brands_response_spec.rb +53 -0
  730. data/spec/models/bulk_envelope_spec.rb +89 -0
  731. data/spec/models/bulk_envelope_status_spec.rb +119 -0
  732. data/spec/models/bulk_envelopes_response_spec.rb +77 -0
  733. data/spec/models/bulk_recipient_signature_provider_spec.rb +47 -0
  734. data/spec/models/bulk_recipient_spec.rb +95 -0
  735. data/spec/models/bulk_recipient_tab_label_spec.rb +47 -0
  736. data/spec/models/bulk_recipients_request_spec.rb +41 -0
  737. data/spec/models/bulk_recipients_response_spec.rb +77 -0
  738. data/spec/models/bulk_recipients_summary_response_spec.rb +59 -0
  739. data/spec/models/bulk_recipients_update_response_spec.rb +41 -0
  740. data/spec/models/captive_recipient_information_spec.rb +41 -0
  741. data/spec/models/captive_recipient_spec.rb +59 -0
  742. data/spec/models/carbon_copy_spec.rb +287 -0
  743. data/spec/models/certified_delivery_spec.rb +287 -0
  744. data/spec/models/checkbox_spec.rb +215 -0
  745. data/spec/models/chunked_upload_part_spec.rb +47 -0
  746. data/spec/models/chunked_upload_request_spec.rb +47 -0
  747. data/spec/models/chunked_upload_response_spec.rb +77 -0
  748. data/spec/models/cloud_storage_provider_spec.rb +65 -0
  749. data/spec/models/cloud_storage_providers_spec.rb +41 -0
  750. data/spec/models/company_spec.rb +269 -0
  751. data/spec/models/composite_template_spec.rb +65 -0
  752. data/spec/models/connect_config_results_spec.rb +47 -0
  753. data/spec/models/connect_custom_configuration_spec.rb +161 -0
  754. data/spec/models/connect_debug_log_spec.rb +65 -0
  755. data/spec/models/connect_failure_filter_spec.rb +47 -0
  756. data/spec/models/connect_failure_result_spec.rb +65 -0
  757. data/spec/models/connect_failure_results_spec.rb +41 -0
  758. data/spec/models/connect_log_spec.rb +143 -0
  759. data/spec/models/connect_logs_spec.rb +59 -0
  760. data/spec/models/console_view_request_spec.rb +47 -0
  761. data/spec/models/consumer_disclosure_spec.rb +215 -0
  762. data/spec/models/contact_get_response_spec.rb +77 -0
  763. data/spec/models/contact_mod_request_spec.rb +41 -0
  764. data/spec/models/contact_spec.rb +89 -0
  765. data/spec/models/contact_update_response_spec.rb +41 -0
  766. data/spec/models/correct_view_request_spec.rb +47 -0
  767. data/spec/models/country_spec.rb +59 -0
  768. data/spec/models/credit_card_information_spec.rb +71 -0
  769. data/spec/models/credit_card_types_spec.rb +41 -0
  770. data/spec/models/currency_feature_set_price_spec.rb +65 -0
  771. data/spec/models/currency_plan_price_spec.rb +71 -0
  772. data/spec/models/custom_field_v2_spec.rb +77 -0
  773. data/spec/models/custom_fields_envelope_spec.rb +47 -0
  774. data/spec/models/custom_fields_spec.rb +47 -0
  775. data/spec/models/custom_settings_information_spec.rb +41 -0
  776. data/spec/models/date_signed_spec.rb +227 -0
  777. data/spec/models/date_spec.rb +305 -0
  778. data/spec/models/decline_spec.rb +239 -0
  779. data/spec/models/diagnostics_settings_information_spec.rb +53 -0
  780. data/spec/models/dob_information_input_spec.rb +53 -0
  781. data/spec/models/document_fields_information_spec.rb +41 -0
  782. data/spec/models/document_spec.rb +155 -0
  783. data/spec/models/document_template_list_spec.rb +41 -0
  784. data/spec/models/document_template_spec.rb +65 -0
  785. data/spec/models/document_visibility_list_spec.rb +41 -0
  786. data/spec/models/document_visibility_spec.rb +65 -0
  787. data/spec/models/e_note_configuration_spec.rb +65 -0
  788. data/spec/models/editor_spec.rb +281 -0
  789. data/spec/models/email_address_spec.rb +221 -0
  790. data/spec/models/email_settings_spec.rb +53 -0
  791. data/spec/models/email_spec.rb +305 -0
  792. data/spec/models/envelope_attachment_spec.rb +71 -0
  793. data/spec/models/envelope_attachments_request_spec.rb +41 -0
  794. data/spec/models/envelope_attachments_result_spec.rb +41 -0
  795. data/spec/models/envelope_audit_event_response_spec.rb +41 -0
  796. data/spec/models/envelope_audit_event_spec.rb +41 -0
  797. data/spec/models/envelope_definition_spec.rb +371 -0
  798. data/spec/models/envelope_document_spec.rb +137 -0
  799. data/spec/models/envelope_documents_result_spec.rb +47 -0
  800. data/spec/models/envelope_event_spec.rb +47 -0
  801. data/spec/models/envelope_form_data_spec.rb +71 -0
  802. data/spec/models/envelope_id_spec.rb +221 -0
  803. data/spec/models/envelope_ids_request_spec.rb +47 -0
  804. data/spec/models/envelope_notification_request_spec.rb +53 -0
  805. data/spec/models/envelope_spec.rb +317 -0
  806. data/spec/models/envelope_summary_spec.rb +59 -0
  807. data/spec/models/envelope_template_definition_spec.rb +125 -0
  808. data/spec/models/envelope_template_result_spec.rb +401 -0
  809. data/spec/models/envelope_template_results_spec.rb +83 -0
  810. data/spec/models/envelope_template_spec.rb +329 -0
  811. data/spec/models/envelope_transaction_status_spec.rb +59 -0
  812. data/spec/models/envelope_update_summary_spec.rb +83 -0
  813. data/spec/models/envelopes_information_spec.rb +83 -0
  814. data/spec/models/error_details_spec.rb +47 -0
  815. data/spec/models/event_notification_spec.rb +125 -0
  816. data/spec/models/event_result_spec.rb +59 -0
  817. data/spec/models/expirations_spec.rb +53 -0
  818. data/spec/models/external_doc_service_error_details_spec.rb +53 -0
  819. data/spec/models/external_file_spec.rb +83 -0
  820. data/spec/models/external_folder_spec.rb +95 -0
  821. data/spec/models/feature_set_spec.rb +89 -0
  822. data/spec/models/file_type_list_spec.rb +41 -0
  823. data/spec/models/file_type_spec.rb +47 -0
  824. data/spec/models/filter_spec.rb +101 -0
  825. data/spec/models/first_name_spec.rb +221 -0
  826. data/spec/models/folder_item_response_spec.rb +77 -0
  827. data/spec/models/folder_item_spec.rb +161 -0
  828. data/spec/models/folder_item_v2_spec.rb +155 -0
  829. data/spec/models/folder_items_response_spec.rb +77 -0
  830. data/spec/models/folder_spec.rb +107 -0
  831. data/spec/models/folders_request_spec.rb +47 -0
  832. data/spec/models/folders_response_spec.rb +41 -0
  833. data/spec/models/forgotten_password_information_spec.rb +83 -0
  834. data/spec/models/formula_tab_spec.rb +329 -0
  835. data/spec/models/full_name_spec.rb +221 -0
  836. data/spec/models/group_information_spec.rb +77 -0
  837. data/spec/models/group_spec.rb +71 -0
  838. data/spec/models/id_check_information_input_spec.rb +59 -0
  839. data/spec/models/in_person_signer_spec.rb +365 -0
  840. data/spec/models/initial_here_spec.rb +197 -0
  841. data/spec/models/inline_template_spec.rb +65 -0
  842. data/spec/models/integrated_user_info_list_spec.rb +83 -0
  843. data/spec/models/intermediary_spec.rb +287 -0
  844. data/spec/models/last_name_spec.rb +221 -0
  845. data/spec/models/list_custom_field_spec.rb +83 -0
  846. data/spec/models/list_item_spec.rb +53 -0
  847. data/spec/models/list_spec.rb +269 -0
  848. data/spec/models/lock_information_spec.rb +83 -0
  849. data/spec/models/lock_request_spec.rb +65 -0
  850. data/spec/models/login_account_spec.rb +101 -0
  851. data/spec/models/login_information_spec.rb +47 -0
  852. data/spec/models/match_box_spec.rb +65 -0
  853. data/spec/models/member_group_shared_item_spec.rb +53 -0
  854. data/spec/models/member_shared_items_spec.rb +59 -0
  855. data/spec/models/merge_field_spec.rb +65 -0
  856. data/spec/models/mobile_notifier_configuration_information_spec.rb +41 -0
  857. data/spec/models/mobile_notifier_configuration_spec.rb +53 -0
  858. data/spec/models/money_spec.rb +53 -0
  859. data/spec/models/name_value_spec.rb +59 -0
  860. data/spec/models/new_account_definition_spec.rb +95 -0
  861. data/spec/models/new_account_summary_spec.rb +77 -0
  862. data/spec/models/new_user_spec.rb +95 -0
  863. data/spec/models/new_users_definition_spec.rb +41 -0
  864. data/spec/models/new_users_summary_spec.rb +41 -0
  865. data/spec/models/notary_host_spec.rb +275 -0
  866. data/spec/models/note_spec.rb +245 -0
  867. data/spec/models/notification_spec.rb +53 -0
  868. data/spec/models/number_spec.rb +317 -0
  869. data/spec/models/oauth_access_spec.rb +71 -0
  870. data/spec/models/offline_attributes_spec.rb +71 -0
  871. data/spec/models/page_images_spec.rb +77 -0
  872. data/spec/models/page_request_spec.rb +47 -0
  873. data/spec/models/page_spec.rb +83 -0
  874. data/spec/models/payment_details_spec.rb +65 -0
  875. data/spec/models/payment_line_item_spec.rb +59 -0
  876. data/spec/models/permission_profile_information_spec.rb +41 -0
  877. data/spec/models/permission_profile_spec.rb +77 -0
  878. data/spec/models/plan_information_spec.rb +71 -0
  879. data/spec/models/post_transactions_request_spec.rb +59 -0
  880. data/spec/models/post_transactions_response_spec.rb +47 -0
  881. data/spec/models/power_form_form_data_envelope_spec.rb +47 -0
  882. data/spec/models/power_form_form_data_recipient_spec.rb +59 -0
  883. data/spec/models/power_form_recipient_spec.rb +113 -0
  884. data/spec/models/power_form_senders_response_spec.rb +77 -0
  885. data/spec/models/power_form_spec.rb +179 -0
  886. data/spec/models/power_forms_form_data_response_spec.rb +41 -0
  887. data/spec/models/power_forms_request_spec.rb +41 -0
  888. data/spec/models/power_forms_response_spec.rb +77 -0
  889. data/spec/models/property_metadata_spec.rb +47 -0
  890. data/spec/models/province_spec.rb +47 -0
  891. data/spec/models/provisioning_information_spec.rb +77 -0
  892. data/spec/models/purchased_envelopes_information_spec.rb +89 -0
  893. data/spec/models/radio_group_spec.rb +89 -0
  894. data/spec/models/radio_spec.rb +143 -0
  895. data/spec/models/recipient_attachment_spec.rb +71 -0
  896. data/spec/models/recipient_domain_spec.rb +59 -0
  897. data/spec/models/recipient_email_notification_spec.rb +53 -0
  898. data/spec/models/recipient_event_spec.rb +47 -0
  899. data/spec/models/recipient_form_data_spec.rb +83 -0
  900. data/spec/models/recipient_names_response_spec.rb +53 -0
  901. data/spec/models/recipient_phone_authentication_spec.rb +59 -0
  902. data/spec/models/recipient_saml_authentication_spec.rb +41 -0
  903. data/spec/models/recipient_signature_information_spec.rb +53 -0
  904. data/spec/models/recipient_signature_provider_options_spec.rb +59 -0
  905. data/spec/models/recipient_signature_provider_spec.rb +47 -0
  906. data/spec/models/recipient_sms_authentication_spec.rb +41 -0
  907. data/spec/models/recipient_update_response_spec.rb +53 -0
  908. data/spec/models/recipient_view_request_spec.rb +119 -0
  909. data/spec/models/recipients_spec.rb +95 -0
  910. data/spec/models/recipients_update_summary_spec.rb +41 -0
  911. data/spec/models/referral_information_spec.rb +143 -0
  912. data/spec/models/reminders_spec.rb +53 -0
  913. data/spec/models/resource_information_spec.rb +41 -0
  914. data/spec/models/return_url_request_spec.rb +41 -0
  915. data/spec/models/saml_assertion_attribute_spec.rb +59 -0
  916. data/spec/models/seat_discount_spec.rb +53 -0
  917. data/spec/models/sender_email_notifications_spec.rb +77 -0
  918. data/spec/models/server_template_spec.rb +47 -0
  919. data/spec/models/service_information_spec.rb +71 -0
  920. data/spec/models/service_version_spec.rb +47 -0
  921. data/spec/models/settings_metadata_spec.rb +71 -0
  922. data/spec/models/shared_item_spec.rb +53 -0
  923. data/spec/models/sign_here_spec.rb +197 -0
  924. data/spec/models/signature_provider_required_option_spec.rb +47 -0
  925. data/spec/models/signature_type_spec.rb +47 -0
  926. data/spec/models/signer_attachment_spec.rb +197 -0
  927. data/spec/models/signer_email_notifications_spec.rb +119 -0
  928. data/spec/models/signer_spec.rb +371 -0
  929. data/spec/models/signing_group_information_spec.rb +41 -0
  930. data/spec/models/signing_group_spec.rb +95 -0
  931. data/spec/models/signing_group_user_spec.rb +53 -0
  932. data/spec/models/signing_group_users_spec.rb +41 -0
  933. data/spec/models/social_account_information_spec.rb +65 -0
  934. data/spec/models/social_authentication_spec.rb +41 -0
  935. data/spec/models/ssn4_information_input_spec.rb +53 -0
  936. data/spec/models/ssn9_information_input_spec.rb +47 -0
  937. data/spec/models/ssn_spec.rb +305 -0
  938. data/spec/models/tab_account_settings_spec.rb +263 -0
  939. data/spec/models/tab_metadata_list_spec.rb +41 -0
  940. data/spec/models/tab_metadata_spec.rb +269 -0
  941. data/spec/models/tabs_spec.rb +185 -0
  942. data/spec/models/template_custom_fields_spec.rb +47 -0
  943. data/spec/models/template_document_visibility_list_spec.rb +41 -0
  944. data/spec/models/template_documents_result_spec.rb +47 -0
  945. data/spec/models/template_information_spec.rb +41 -0
  946. data/spec/models/template_match_spec.rb +53 -0
  947. data/spec/models/template_notification_request_spec.rb +59 -0
  948. data/spec/models/template_recipients_spec.rb +95 -0
  949. data/spec/models/template_role_spec.rb +107 -0
  950. data/spec/models/template_shared_item_spec.rb +77 -0
  951. data/spec/models/template_summary_spec.rb +77 -0
  952. data/spec/models/template_tabs_spec.rb +185 -0
  953. data/spec/models/template_update_summary_spec.rb +83 -0
  954. data/spec/models/text_custom_field_spec.rb +77 -0
  955. data/spec/models/text_spec.rb +323 -0
  956. data/spec/models/title_spec.rb +269 -0
  957. data/spec/models/usage_history_spec.rb +59 -0
  958. data/spec/models/user_account_management_granular_information_spec.rb +83 -0
  959. data/spec/models/user_info_list_spec.rb +41 -0
  960. data/spec/models/user_info_spec.rb +95 -0
  961. data/spec/models/user_information_list_spec.rb +77 -0
  962. data/spec/models/user_information_spec.rb +239 -0
  963. data/spec/models/user_password_information_spec.rb +59 -0
  964. data/spec/models/user_profile_spec.rb +107 -0
  965. data/spec/models/user_settings_information_spec.rb +59 -0
  966. data/spec/models/user_shared_item_spec.rb +53 -0
  967. data/spec/models/user_signature_definition_spec.rb +59 -0
  968. data/spec/models/user_signature_spec.rb +113 -0
  969. data/spec/models/user_signatures_information_spec.rb +41 -0
  970. data/spec/models/user_social_id_result_spec.rb +47 -0
  971. data/spec/models/users_response_spec.rb +77 -0
  972. data/spec/models/view_link_request_spec.rb +47 -0
  973. data/spec/models/view_spec.rb +245 -0
  974. data/spec/models/view_url_spec.rb +41 -0
  975. data/spec/models/workspace_folder_contents_spec.rb +83 -0
  976. data/spec/models/workspace_item_list_spec.rb +41 -0
  977. data/spec/models/workspace_item_spec.rb +149 -0
  978. data/spec/models/workspace_list_spec.rb +65 -0
  979. data/spec/models/workspace_spec.rb +101 -0
  980. data/spec/models/workspace_user_authorization_spec.rb +101 -0
  981. data/spec/models/workspace_user_spec.rb +131 -0
  982. data/spec/models/zip_spec.rb +311 -0
  983. data/spec/spec_helper.rb +110 -0
  984. data/tests/.DS_Store +0 -0
  985. data/tests/Gemfile +5 -0
  986. data/tests/Gemfile.lock +42 -0
  987. data/tests/docs/Test.pdf +0 -0
  988. data/tests/rsa_keys/private.pem +27 -0
  989. data/tests/rsa_keys/public.pem +9 -0
  990. data/tests/spec/unit_tests_spec.rb +360 -0
  991. data/tests/spec/unit_tests_using_jwt_spec.rb +361 -0
  992. metadata +1560 -0
@@ -0,0 +1,1694 @@
1
+ =begin
2
+ #DocuSign REST API
3
+
4
+ #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require "uri"
13
+
14
+ module DocuSign_eSign
15
+
16
+ class GetInformationOptions
17
+ # When set to **true**, the full list of user information is returned for each user in the account.
18
+ attr_accessor :additional_info
19
+
20
+ #
21
+ attr_accessor :email
22
+
23
+ def self.default
24
+ @@default ||= GetInformationOptions.new
25
+ end
26
+ end
27
+
28
+ class GetProfileImageOptions
29
+ #
30
+ attr_accessor :encoding
31
+
32
+ def self.default
33
+ @@default ||= GetProfileImageOptions.new
34
+ end
35
+ end
36
+
37
+ class GetSignatureImageOptions
38
+ #
39
+ attr_accessor :include_chrome
40
+
41
+ def self.default
42
+ @@default ||= GetSignatureImageOptions.new
43
+ end
44
+ end
45
+
46
+ class ListOptions
47
+ # When set to **true**, the full list of user information is returned for each user in the account.
48
+ attr_accessor :additional_info
49
+
50
+ # Number of records to return. The number must be greater than 0 and less than or equal to 100.
51
+ attr_accessor :count
52
+
53
+ #
54
+ attr_accessor :email
55
+
56
+ # Filters the returned user records by the email address or a sub-string of email address.
57
+ attr_accessor :email_substring
58
+
59
+ # Filters user records returned by one or more group Id's.
60
+ attr_accessor :group_id
61
+
62
+ #
63
+ attr_accessor :include_usersettings_for_csv
64
+
65
+ #
66
+ attr_accessor :login_status
67
+
68
+ #
69
+ attr_accessor :not_group_id
70
+
71
+ # Starting value for the list.
72
+ attr_accessor :start_position
73
+
74
+ #
75
+ attr_accessor :status
76
+
77
+ # Filters the user records returned by the user name or a sub-string of user name.
78
+ attr_accessor :user_name_substring
79
+
80
+ def self.default
81
+ @@default ||= ListOptions.new
82
+ end
83
+ end
84
+
85
+ class UpdateSignatureOptions
86
+ # When set to **true**, closes the current signature.
87
+ attr_accessor :close_existing_signature
88
+
89
+ def self.default
90
+ @@default ||= UpdateSignatureOptions.new
91
+ end
92
+ end
93
+
94
+
95
+ class UsersApi
96
+ attr_accessor :api_client
97
+
98
+ def initialize(api_client = UsersApi.default)
99
+ @api_client = api_client
100
+ end
101
+
102
+ # Adds news user to the specified account.
103
+ # Adds new users to your account. Set the `userSettings` property in the request to specify the actions the users can perform on the account.
104
+ # @param account_id The external account number (int) or account ID Guid.
105
+ # @param new_users_definition (optional parameter)
106
+ # @return [NewUsersSummary]
107
+ def create(account_id, new_users_definition)
108
+ data, _status_code, _headers = create_with_http_info(account_id, new_users_definition)
109
+ return data
110
+ end
111
+
112
+ # Adds news user to the specified account.
113
+ # Adds new users to your account. Set the `userSettings` property in the request to specify the actions the users can perform on the account.
114
+ # @param account_id The external account number (int) or account ID Guid.
115
+ # @param new_users_definition (optional parameter)
116
+ # @return [Array<(NewUsersSummary, Fixnum, Hash)>] NewUsersSummary data, response status code and response headers
117
+ def create_with_http_info(account_id, new_users_definition)
118
+ if @api_client.config.debugging
119
+ @api_client.config.logger.debug "Calling API: UsersApi.create ..."
120
+ end
121
+ # verify the required parameter 'account_id' is set
122
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.create" if account_id.nil?
123
+ # resource path
124
+ local_var_path = "/v2/accounts/{accountId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
125
+
126
+ # query parameters
127
+ query_params = {}
128
+
129
+ # header parameters
130
+ header_params = {}
131
+ # HTTP header 'Accept' (if needed)
132
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
133
+
134
+ # form parameters
135
+ form_params = {}
136
+
137
+ # http body (model)
138
+ post_body = @api_client.object_to_http_body(new_users_definition)
139
+ auth_names = []
140
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
141
+ :header_params => header_params,
142
+ :query_params => query_params,
143
+ :form_params => form_params,
144
+ :body => post_body,
145
+ :auth_names => auth_names,
146
+ :return_type => 'NewUsersSummary')
147
+ if @api_client.config.debugging
148
+ @api_client.config.logger.debug "API called: UsersApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
149
+ end
150
+ return data, status_code, headers
151
+ end
152
+
153
+ # Adds user Signature and initials images to a Signature.
154
+ # 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.
155
+ # @param account_id The external account number (int) or account ID Guid.
156
+ # @param user_id 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.
157
+ # @param user_signatures_information (optional parameter)
158
+ # @return [UserSignaturesInformation]
159
+ def create_signatures(account_id, user_id, user_signatures_information)
160
+ data, _status_code, _headers = create_signatures_with_http_info(account_id, user_id, user_signatures_information)
161
+ return data
162
+ end
163
+
164
+ # Adds user Signature and initials images to a Signature.
165
+ # 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&#39;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 \&quot;filename\&quot; value that is used to map to the &#x60;signatureName&#x60; and/or &#x60;signatureInitials&#x60; properties in the JSON to the image. For example: &#x60;Content-Disposition: file; filename&#x3D;\&quot;Ron Test20121127083900\&quot;&#x60; 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.
166
+ # @param account_id The external account number (int) or account ID Guid.
167
+ # @param user_id 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.
168
+ # @param user_signatures_information (optional parameter)
169
+ # @return [Array<(UserSignaturesInformation, Fixnum, Hash)>] UserSignaturesInformation data, response status code and response headers
170
+ def create_signatures_with_http_info(account_id, user_id, user_signatures_information)
171
+ if @api_client.config.debugging
172
+ @api_client.config.logger.debug "Calling API: UsersApi.create_signatures ..."
173
+ end
174
+ # verify the required parameter 'account_id' is set
175
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.create_signatures" if account_id.nil?
176
+ # verify the required parameter 'user_id' is set
177
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.create_signatures" if user_id.nil?
178
+ # resource path
179
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
180
+
181
+ # query parameters
182
+ query_params = {}
183
+
184
+ # header parameters
185
+ header_params = {}
186
+ # HTTP header 'Accept' (if needed)
187
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
188
+
189
+ # form parameters
190
+ form_params = {}
191
+
192
+ # http body (model)
193
+ post_body = @api_client.object_to_http_body(user_signatures_information)
194
+ auth_names = []
195
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
196
+ :header_params => header_params,
197
+ :query_params => query_params,
198
+ :form_params => form_params,
199
+ :body => post_body,
200
+ :auth_names => auth_names,
201
+ :return_type => 'UserSignaturesInformation')
202
+ if @api_client.config.debugging
203
+ @api_client.config.logger.debug "API called: UsersApi#create_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
204
+ end
205
+ return data, status_code, headers
206
+ end
207
+
208
+ # Removes users account privileges.
209
+ # 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.
210
+ # @param account_id The external account number (int) or account ID Guid.
211
+ # @param user_info_list (optional parameter)
212
+ # @return [UsersResponse]
213
+ def delete(account_id, user_info_list)
214
+ data, _status_code, _headers = delete_with_http_info(account_id, user_info_list)
215
+ return data
216
+ end
217
+
218
+ # Removes users account privileges.
219
+ # 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 &#x60;errorDetails&#x60; node with &#x60;errorCode&#x60; and &#x60;message&#x60; properties.
220
+ # @param account_id The external account number (int) or account ID Guid.
221
+ # @param user_info_list (optional parameter)
222
+ # @return [Array<(UsersResponse, Fixnum, Hash)>] UsersResponse data, response status code and response headers
223
+ def delete_with_http_info(account_id, user_info_list)
224
+ if @api_client.config.debugging
225
+ @api_client.config.logger.debug "Calling API: UsersApi.delete ..."
226
+ end
227
+ # verify the required parameter 'account_id' is set
228
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete" if account_id.nil?
229
+ # resource path
230
+ local_var_path = "/v2/accounts/{accountId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
231
+
232
+ # query parameters
233
+ query_params = {}
234
+
235
+ # header parameters
236
+ header_params = {}
237
+ # HTTP header 'Accept' (if needed)
238
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
239
+
240
+ # form parameters
241
+ form_params = {}
242
+
243
+ # http body (model)
244
+ post_body = @api_client.object_to_http_body(user_info_list)
245
+ auth_names = []
246
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
247
+ :header_params => header_params,
248
+ :query_params => query_params,
249
+ :form_params => form_params,
250
+ :body => post_body,
251
+ :auth_names => auth_names,
252
+ :return_type => 'UsersResponse')
253
+ if @api_client.config.debugging
254
+ @api_client.config.logger.debug "API called: UsersApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
255
+ end
256
+ return data, status_code, headers
257
+ end
258
+
259
+ # Replaces a particular contact associated with an account for the DocuSign service.
260
+ #
261
+ # @param account_id The external account number (int) or account ID Guid.
262
+ # @param contact_id The unique identifier of a person in the contacts address book.
263
+ # @return [ContactUpdateResponse]
264
+ def delete_contact_with_id(account_id, contact_id)
265
+ data, _status_code, _headers = delete_contact_with_id_with_http_info(account_id, contact_id)
266
+ return data
267
+ end
268
+
269
+ # Replaces a particular contact associated with an account for the DocuSign service.
270
+ #
271
+ # @param account_id The external account number (int) or account ID Guid.
272
+ # @param contact_id The unique identifier of a person in the contacts address book.
273
+ # @return [Array<(ContactUpdateResponse, Fixnum, Hash)>] ContactUpdateResponse data, response status code and response headers
274
+ def delete_contact_with_id_with_http_info(account_id, contact_id)
275
+ if @api_client.config.debugging
276
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_contact_with_id ..."
277
+ end
278
+ # verify the required parameter 'account_id' is set
279
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_contact_with_id" if account_id.nil?
280
+ # verify the required parameter 'contact_id' is set
281
+ fail ArgumentError, "Missing the required parameter 'contact_id' when calling UsersApi.delete_contact_with_id" if contact_id.nil?
282
+ # resource path
283
+ local_var_path = "/v2/accounts/{accountId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)
284
+
285
+ # query parameters
286
+ query_params = {}
287
+
288
+ # header parameters
289
+ header_params = {}
290
+ # HTTP header 'Accept' (if needed)
291
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
292
+
293
+ # form parameters
294
+ form_params = {}
295
+
296
+ # http body (model)
297
+ post_body = nil
298
+ auth_names = []
299
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
300
+ :header_params => header_params,
301
+ :query_params => query_params,
302
+ :form_params => form_params,
303
+ :body => post_body,
304
+ :auth_names => auth_names,
305
+ :return_type => 'ContactUpdateResponse')
306
+ if @api_client.config.debugging
307
+ @api_client.config.logger.debug "API called: UsersApi#delete_contact_with_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
308
+ end
309
+ return data, status_code, headers
310
+ end
311
+
312
+ # Delete contacts associated with an account for the DocuSign service.
313
+ #
314
+ # @param account_id The external account number (int) or account ID Guid.
315
+ # @param contact_mod_request (optional parameter)
316
+ # @return [ContactUpdateResponse]
317
+ def delete_contacts(account_id, contact_mod_request)
318
+ data, _status_code, _headers = delete_contacts_with_http_info(account_id, contact_mod_request)
319
+ return data
320
+ end
321
+
322
+ # Delete contacts associated with an account for the DocuSign service.
323
+ #
324
+ # @param account_id The external account number (int) or account ID Guid.
325
+ # @param contact_mod_request (optional parameter)
326
+ # @return [Array<(ContactUpdateResponse, Fixnum, Hash)>] ContactUpdateResponse data, response status code and response headers
327
+ def delete_contacts_with_http_info(account_id, contact_mod_request)
328
+ if @api_client.config.debugging
329
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_contacts ..."
330
+ end
331
+ # verify the required parameter 'account_id' is set
332
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_contacts" if account_id.nil?
333
+ # resource path
334
+ local_var_path = "/v2/accounts/{accountId}/contacts".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
335
+
336
+ # query parameters
337
+ query_params = {}
338
+
339
+ # header parameters
340
+ header_params = {}
341
+ # HTTP header 'Accept' (if needed)
342
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
343
+
344
+ # form parameters
345
+ form_params = {}
346
+
347
+ # http body (model)
348
+ post_body = @api_client.object_to_http_body(contact_mod_request)
349
+ auth_names = []
350
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
351
+ :header_params => header_params,
352
+ :query_params => query_params,
353
+ :form_params => form_params,
354
+ :body => post_body,
355
+ :auth_names => auth_names,
356
+ :return_type => 'ContactUpdateResponse')
357
+ if @api_client.config.debugging
358
+ @api_client.config.logger.debug "API called: UsersApi#delete_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
359
+ end
360
+ return data, status_code, headers
361
+ end
362
+
363
+ # Deletes custom user settings for a specified user.
364
+ # 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.
365
+ # @param account_id The external account number (int) or account ID Guid.
366
+ # @param user_id 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.
367
+ # @param custom_settings_information (optional parameter)
368
+ # @return [CustomSettingsInformation]
369
+ def delete_custom_settings(account_id, user_id, custom_settings_information)
370
+ data, _status_code, _headers = delete_custom_settings_with_http_info(account_id, user_id, custom_settings_information)
371
+ return data
372
+ end
373
+
374
+ # Deletes custom user settings for a specified user.
375
+ # 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: &#x60;X-DocuSign-User-Settings-Key:group_name&#x60; Where the &#x60;group_name&#x60; 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.
376
+ # @param account_id The external account number (int) or account ID Guid.
377
+ # @param user_id 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
+ # @param custom_settings_information (optional parameter)
379
+ # @return [Array<(CustomSettingsInformation, Fixnum, Hash)>] CustomSettingsInformation data, response status code and response headers
380
+ def delete_custom_settings_with_http_info(account_id, user_id, custom_settings_information)
381
+ if @api_client.config.debugging
382
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_custom_settings ..."
383
+ end
384
+ # verify the required parameter 'account_id' is set
385
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_custom_settings" if account_id.nil?
386
+ # verify the required parameter 'user_id' is set
387
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_custom_settings" if user_id.nil?
388
+ # resource path
389
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/custom_settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
390
+
391
+ # query parameters
392
+ query_params = {}
393
+
394
+ # header parameters
395
+ header_params = {}
396
+ # HTTP header 'Accept' (if needed)
397
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
398
+
399
+ # form parameters
400
+ form_params = {}
401
+
402
+ # http body (model)
403
+ post_body = @api_client.object_to_http_body(custom_settings_information)
404
+ auth_names = []
405
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
406
+ :header_params => header_params,
407
+ :query_params => query_params,
408
+ :form_params => form_params,
409
+ :body => post_body,
410
+ :auth_names => auth_names,
411
+ :return_type => 'CustomSettingsInformation')
412
+ if @api_client.config.debugging
413
+ @api_client.config.logger.debug "API called: UsersApi#delete_custom_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
414
+ end
415
+ return data, status_code, headers
416
+ end
417
+
418
+ # Deletes the user profile image for the specified user.
419
+ # 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.
420
+ # @param account_id The external account number (int) or account ID Guid.
421
+ # @param user_id 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.
422
+ # @return [nil]
423
+ def delete_profile_image(account_id, user_id)
424
+ delete_profile_image_with_http_info(account_id, user_id)
425
+ return nil
426
+ end
427
+
428
+ # Deletes the user profile image for the specified user.
429
+ # Deletes the user profile image from the specified user&#39;s profile. The userId parameter specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the specified account.
430
+ # @param account_id The external account number (int) or account ID Guid.
431
+ # @param user_id 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.
432
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
433
+ def delete_profile_image_with_http_info(account_id, user_id)
434
+ if @api_client.config.debugging
435
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_profile_image ..."
436
+ end
437
+ # verify the required parameter 'account_id' is set
438
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_profile_image" if account_id.nil?
439
+ # verify the required parameter 'user_id' is set
440
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_profile_image" if user_id.nil?
441
+ # resource path
442
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile/image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
443
+
444
+ # query parameters
445
+ query_params = {}
446
+
447
+ # header parameters
448
+ header_params = {}
449
+ # HTTP header 'Accept' (if needed)
450
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
451
+
452
+ # form parameters
453
+ form_params = {}
454
+
455
+ # http body (model)
456
+ post_body = nil
457
+ auth_names = []
458
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
459
+ :header_params => header_params,
460
+ :query_params => query_params,
461
+ :form_params => form_params,
462
+ :body => post_body,
463
+ :auth_names => auth_names)
464
+ if @api_client.config.debugging
465
+ @api_client.config.logger.debug "API called: UsersApi#delete_profile_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
466
+ end
467
+ return data, status_code, headers
468
+ end
469
+
470
+ # Removes removes signature information for the specified user.
471
+ # 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\".
472
+ # @param account_id The external account number (int) or account ID Guid.
473
+ # @param signature_id The ID of the signature being accessed.
474
+ # @param user_id 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.
475
+ # @return [nil]
476
+ def delete_signature(account_id, signature_id, user_id)
477
+ delete_signature_with_http_info(account_id, signature_id, user_id)
478
+ return nil
479
+ end
480
+
481
+ # Removes removes signature information for the specified user.
482
+ # Removes the signature information for the user. The userId parameter specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), 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 \&quot;Bob Smith\&quot; as \&quot;Bob%20Smith\&quot;.
483
+ # @param account_id The external account number (int) or account ID Guid.
484
+ # @param signature_id The ID of the signature being accessed.
485
+ # @param user_id 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
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
487
+ def delete_signature_with_http_info(account_id, signature_id, user_id)
488
+ if @api_client.config.debugging
489
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_signature ..."
490
+ end
491
+ # verify the required parameter 'account_id' is set
492
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_signature" if account_id.nil?
493
+ # verify the required parameter 'signature_id' is set
494
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.delete_signature" if signature_id.nil?
495
+ # verify the required parameter 'user_id' is set
496
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_signature" if user_id.nil?
497
+ # resource path
498
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
499
+
500
+ # query parameters
501
+ query_params = {}
502
+
503
+ # header parameters
504
+ header_params = {}
505
+ # HTTP header 'Accept' (if needed)
506
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
507
+
508
+ # form parameters
509
+ form_params = {}
510
+
511
+ # http body (model)
512
+ post_body = nil
513
+ auth_names = []
514
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
515
+ :header_params => header_params,
516
+ :query_params => query_params,
517
+ :form_params => form_params,
518
+ :body => post_body,
519
+ :auth_names => auth_names)
520
+ if @api_client.config.debugging
521
+ @api_client.config.logger.debug "API called: UsersApi#delete_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
522
+ end
523
+ return data, status_code, headers
524
+ end
525
+
526
+ # Deletes the user initials image or the user signature image for the specified user.
527
+ # 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\".
528
+ # @param account_id The external account number (int) or account ID Guid.
529
+ # @param image_type One of **signature_image** or **initials_image**.
530
+ # @param signature_id The ID of the signature being accessed.
531
+ # @param user_id 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.
532
+ # @return [UserSignature]
533
+ def delete_signature_image(account_id, image_type, signature_id, user_id)
534
+ data, _status_code, _headers = delete_signature_image_with_http_info(account_id, image_type, signature_id, user_id)
535
+ return data
536
+ end
537
+
538
+ # Deletes the user initials image or the user signature image for the specified user.
539
+ # 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&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), 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 \&quot;Bob Smith\&quot; as \&quot;Bob%20Smith\&quot;.
540
+ # @param account_id The external account number (int) or account ID Guid.
541
+ # @param image_type One of **signature_image** or **initials_image**.
542
+ # @param signature_id The ID of the signature being accessed.
543
+ # @param user_id 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.
544
+ # @return [Array<(UserSignature, Fixnum, Hash)>] UserSignature data, response status code and response headers
545
+ def delete_signature_image_with_http_info(account_id, image_type, signature_id, user_id)
546
+ if @api_client.config.debugging
547
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_signature_image ..."
548
+ end
549
+ # verify the required parameter 'account_id' is set
550
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.delete_signature_image" if account_id.nil?
551
+ # verify the required parameter 'image_type' is set
552
+ fail ArgumentError, "Missing the required parameter 'image_type' when calling UsersApi.delete_signature_image" if image_type.nil?
553
+ # verify the required parameter 'signature_id' is set
554
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.delete_signature_image" if signature_id.nil?
555
+ # verify the required parameter 'user_id' is set
556
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_signature_image" if user_id.nil?
557
+ # resource path
558
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
559
+
560
+ # query parameters
561
+ query_params = {}
562
+
563
+ # header parameters
564
+ header_params = {}
565
+ # HTTP header 'Accept' (if needed)
566
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
567
+
568
+ # form parameters
569
+ form_params = {}
570
+
571
+ # http body (model)
572
+ post_body = nil
573
+ auth_names = []
574
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
575
+ :header_params => header_params,
576
+ :query_params => query_params,
577
+ :form_params => form_params,
578
+ :body => post_body,
579
+ :auth_names => auth_names,
580
+ :return_type => 'UserSignature')
581
+ if @api_client.config.debugging
582
+ @api_client.config.logger.debug "API called: UsersApi#delete_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
583
+ end
584
+ return data, status_code, headers
585
+ end
586
+
587
+ # Gets a particular contact associated with the user's account.
588
+ #
589
+ # @param account_id The external account number (int) or account ID Guid.
590
+ # @param contact_id The unique identifier of a person in the contacts address book.
591
+ # @return [ContactGetResponse]
592
+ def get_contact_by_id(account_id, contact_id)
593
+ data, _status_code, _headers = get_contact_by_id_with_http_info(account_id, contact_id)
594
+ return data
595
+ end
596
+
597
+ # Gets a particular contact associated with the user&#39;s account.
598
+ #
599
+ # @param account_id The external account number (int) or account ID Guid.
600
+ # @param contact_id The unique identifier of a person in the contacts address book.
601
+ # @return [Array<(ContactGetResponse, Fixnum, Hash)>] ContactGetResponse data, response status code and response headers
602
+ def get_contact_by_id_with_http_info(account_id, contact_id)
603
+ if @api_client.config.debugging
604
+ @api_client.config.logger.debug "Calling API: UsersApi.get_contact_by_id ..."
605
+ end
606
+ # verify the required parameter 'account_id' is set
607
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_contact_by_id" if account_id.nil?
608
+ # verify the required parameter 'contact_id' is set
609
+ fail ArgumentError, "Missing the required parameter 'contact_id' when calling UsersApi.get_contact_by_id" if contact_id.nil?
610
+ # resource path
611
+ local_var_path = "/v2/accounts/{accountId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)
612
+
613
+ # query parameters
614
+ query_params = {}
615
+
616
+ # header parameters
617
+ header_params = {}
618
+ # HTTP header 'Accept' (if needed)
619
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
620
+
621
+ # form parameters
622
+ form_params = {}
623
+
624
+ # http body (model)
625
+ post_body = nil
626
+ auth_names = []
627
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
628
+ :header_params => header_params,
629
+ :query_params => query_params,
630
+ :form_params => form_params,
631
+ :body => post_body,
632
+ :auth_names => auth_names,
633
+ :return_type => 'ContactGetResponse')
634
+ if @api_client.config.debugging
635
+ @api_client.config.logger.debug "API called: UsersApi#get_contact_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
636
+ end
637
+ return data, status_code, headers
638
+ end
639
+
640
+ # Gets the user information for a specified user.
641
+ # 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**.
642
+ # @param account_id The external account number (int) or account ID Guid.
643
+ # @param user_id 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.
644
+ # @param DocuSign_eSign::GetInformationOptions Options for modifying the behavior of the function.
645
+ # @return [UserInformation]
646
+ def get_information(account_id, user_id, options = DocuSign_eSign::GetInformationOptions.default)
647
+ data, _status_code, _headers = get_information_with_http_info(account_id, user_id, options)
648
+ return data
649
+ end
650
+
651
+ # Gets the user information for a specified user.
652
+ # Retrieves the user information for the specified user. To return additional user information that details the last login date, login status, and the user&#39;s password expiration date, set the optional &#x60;additional_info&#x60; query string parameter to **true**.
653
+ # @param account_id The external account number (int) or account ID Guid.
654
+ # @param user_id 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.
655
+ # @param DocuSign_eSign::GetInformationOptions Options for modifying the behavior of the function.
656
+ # @return [Array<(UserInformation, Fixnum, Hash)>] UserInformation data, response status code and response headers
657
+ def get_information_with_http_info(account_id, user_id, options = DocuSign_eSign::GetInformationOptions.default)
658
+ if @api_client.config.debugging
659
+ @api_client.config.logger.debug "Calling API: UsersApi.get_information ..."
660
+ end
661
+ # verify the required parameter 'account_id' is set
662
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_information" if account_id.nil?
663
+ # verify the required parameter 'user_id' is set
664
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_information" if user_id.nil?
665
+ # resource path
666
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
667
+
668
+ # query parameters
669
+ query_params = {}
670
+ query_params[:'additional_info'] = options.additional_info if !options.additional_info.nil?
671
+ query_params[:'email'] = options.email if !options.email.nil?
672
+
673
+ # header parameters
674
+ header_params = {}
675
+ # HTTP header 'Accept' (if needed)
676
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
677
+
678
+ # form parameters
679
+ form_params = {}
680
+
681
+ # http body (model)
682
+ post_body = nil
683
+ auth_names = []
684
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
685
+ :header_params => header_params,
686
+ :query_params => query_params,
687
+ :form_params => form_params,
688
+ :body => post_body,
689
+ :auth_names => auth_names,
690
+ :return_type => 'UserInformation')
691
+ if @api_client.config.debugging
692
+ @api_client.config.logger.debug "API called: UsersApi#get_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
693
+ end
694
+ return data, status_code, headers
695
+ end
696
+
697
+ # Retrieves the user profile for a specified user.
698
+ # 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.
699
+ # @param account_id The external account number (int) or account ID Guid.
700
+ # @param user_id 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.
701
+ # @return [UserProfile]
702
+ def get_profile(account_id, user_id)
703
+ data, _status_code, _headers = get_profile_with_http_info(account_id, user_id)
704
+ return data
705
+ end
706
+
707
+ # Retrieves the user profile for a specified user.
708
+ # 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&#39;s user ID and the user must be a member of the specified account.
709
+ # @param account_id The external account number (int) or account ID Guid.
710
+ # @param user_id 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.
711
+ # @return [Array<(UserProfile, Fixnum, Hash)>] UserProfile data, response status code and response headers
712
+ def get_profile_with_http_info(account_id, user_id)
713
+ if @api_client.config.debugging
714
+ @api_client.config.logger.debug "Calling API: UsersApi.get_profile ..."
715
+ end
716
+ # verify the required parameter 'account_id' is set
717
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_profile" if account_id.nil?
718
+ # verify the required parameter 'user_id' is set
719
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_profile" if user_id.nil?
720
+ # resource path
721
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
722
+
723
+ # query parameters
724
+ query_params = {}
725
+
726
+ # header parameters
727
+ header_params = {}
728
+ # HTTP header 'Accept' (if needed)
729
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
730
+
731
+ # form parameters
732
+ form_params = {}
733
+
734
+ # http body (model)
735
+ post_body = nil
736
+ auth_names = []
737
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
738
+ :header_params => header_params,
739
+ :query_params => query_params,
740
+ :form_params => form_params,
741
+ :body => post_body,
742
+ :auth_names => auth_names,
743
+ :return_type => 'UserProfile')
744
+ if @api_client.config.debugging
745
+ @api_client.config.logger.debug "API called: UsersApi#get_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
746
+ end
747
+ return data, status_code, headers
748
+ end
749
+
750
+ # Retrieves the user profile image for the specified user.
751
+ # 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.
752
+ # @param account_id The external account number (int) or account ID Guid.
753
+ # @param user_id 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.
754
+ # @param DocuSign_eSign::GetProfileImageOptions Options for modifying the behavior of the function.
755
+ # @return [File]
756
+ def get_profile_image(account_id, user_id, options = DocuSign_eSign::GetProfileImageOptions.default)
757
+ data, _status_code, _headers = get_profile_image_with_http_info(account_id, user_id, options)
758
+ return data
759
+ end
760
+
761
+ # Retrieves the user profile image for the specified user.
762
+ # 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&#39;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.
763
+ # @param account_id The external account number (int) or account ID Guid.
764
+ # @param user_id 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.
765
+ # @param DocuSign_eSign::GetProfileImageOptions Options for modifying the behavior of the function.
766
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
767
+ def get_profile_image_with_http_info(account_id, user_id, options = DocuSign_eSign::GetProfileImageOptions.default)
768
+ if @api_client.config.debugging
769
+ @api_client.config.logger.debug "Calling API: UsersApi.get_profile_image ..."
770
+ end
771
+ # verify the required parameter 'account_id' is set
772
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_profile_image" if account_id.nil?
773
+ # verify the required parameter 'user_id' is set
774
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_profile_image" if user_id.nil?
775
+ # resource path
776
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile/image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
777
+
778
+ # query parameters
779
+ query_params = {}
780
+ query_params[:'encoding'] = options.encoding if !options.encoding.nil?
781
+
782
+ # header parameters
783
+ header_params = {}
784
+ # HTTP header 'Accept' (if needed)
785
+ header_params['Accept'] = @api_client.select_header_accept(['image/gif'])
786
+
787
+ # form parameters
788
+ form_params = {}
789
+
790
+ # http body (model)
791
+ post_body = nil
792
+ auth_names = []
793
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
794
+ :header_params => header_params,
795
+ :query_params => query_params,
796
+ :form_params => form_params,
797
+ :body => post_body,
798
+ :auth_names => auth_names,
799
+ :return_type => 'File')
800
+ if @api_client.config.debugging
801
+ @api_client.config.logger.debug "API called: UsersApi#get_profile_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
802
+ end
803
+ return data, status_code, headers
804
+ end
805
+
806
+ # Gets the user account settings for a specified user.
807
+ # 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].
808
+ # @param account_id The external account number (int) or account ID Guid.
809
+ # @param user_id 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.
810
+ # @return [UserSettingsInformation]
811
+ def get_settings(account_id, user_id)
812
+ data, _status_code, _headers = get_settings_with_http_info(account_id, user_id)
813
+ return data
814
+ end
815
+
816
+ # Gets the user account settings for a specified user.
817
+ # 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].
818
+ # @param account_id The external account number (int) or account ID Guid.
819
+ # @param user_id 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.
820
+ # @return [Array<(UserSettingsInformation, Fixnum, Hash)>] UserSettingsInformation data, response status code and response headers
821
+ def get_settings_with_http_info(account_id, user_id)
822
+ if @api_client.config.debugging
823
+ @api_client.config.logger.debug "Calling API: UsersApi.get_settings ..."
824
+ end
825
+ # verify the required parameter 'account_id' is set
826
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_settings" if account_id.nil?
827
+ # verify the required parameter 'user_id' is set
828
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_settings" if user_id.nil?
829
+ # resource path
830
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
831
+
832
+ # query parameters
833
+ query_params = {}
834
+
835
+ # header parameters
836
+ header_params = {}
837
+ # HTTP header 'Accept' (if needed)
838
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
839
+
840
+ # form parameters
841
+ form_params = {}
842
+
843
+ # http body (model)
844
+ post_body = nil
845
+ auth_names = []
846
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
847
+ :header_params => header_params,
848
+ :query_params => query_params,
849
+ :form_params => form_params,
850
+ :body => post_body,
851
+ :auth_names => auth_names,
852
+ :return_type => 'UserSettingsInformation')
853
+ if @api_client.config.debugging
854
+ @api_client.config.logger.debug "API called: UsersApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
855
+ end
856
+ return data, status_code, headers
857
+ end
858
+
859
+ # Gets the user signature information for the specified user.
860
+ # 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\".
861
+ # @param account_id The external account number (int) or account ID Guid.
862
+ # @param signature_id The ID of the signature being accessed.
863
+ # @param user_id 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.
864
+ # @return [UserSignature]
865
+ def get_signature(account_id, signature_id, user_id)
866
+ data, _status_code, _headers = get_signature_with_http_info(account_id, signature_id, user_id)
867
+ return data
868
+ end
869
+
870
+ # Gets the user signature information for the specified user.
871
+ # Retrieves the structure of a single signature with a known signature name. The userId specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), 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 \&quot;Bob Smith\&quot; as \&quot;Bob%20Smith\&quot;.
872
+ # @param account_id The external account number (int) or account ID Guid.
873
+ # @param signature_id The ID of the signature being accessed.
874
+ # @param user_id 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.
875
+ # @return [Array<(UserSignature, Fixnum, Hash)>] UserSignature data, response status code and response headers
876
+ def get_signature_with_http_info(account_id, signature_id, user_id)
877
+ if @api_client.config.debugging
878
+ @api_client.config.logger.debug "Calling API: UsersApi.get_signature ..."
879
+ end
880
+ # verify the required parameter 'account_id' is set
881
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_signature" if account_id.nil?
882
+ # verify the required parameter 'signature_id' is set
883
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.get_signature" if signature_id.nil?
884
+ # verify the required parameter 'user_id' is set
885
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_signature" if user_id.nil?
886
+ # resource path
887
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
888
+
889
+ # query parameters
890
+ query_params = {}
891
+
892
+ # header parameters
893
+ header_params = {}
894
+ # HTTP header 'Accept' (if needed)
895
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
896
+
897
+ # form parameters
898
+ form_params = {}
899
+
900
+ # http body (model)
901
+ post_body = nil
902
+ auth_names = []
903
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
904
+ :header_params => header_params,
905
+ :query_params => query_params,
906
+ :form_params => form_params,
907
+ :body => post_body,
908
+ :auth_names => auth_names,
909
+ :return_type => 'UserSignature')
910
+ if @api_client.config.debugging
911
+ @api_client.config.logger.debug "API called: UsersApi#get_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
912
+ end
913
+ return data, status_code, headers
914
+ end
915
+
916
+ # Retrieves the user initials image or the user signature image for the specified user.
917
+ # 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.
918
+ # @param account_id The external account number (int) or account ID Guid.
919
+ # @param image_type One of **signature_image** or **initials_image**.
920
+ # @param signature_id The ID of the signature being accessed.
921
+ # @param user_id 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.
922
+ # @param DocuSign_eSign::GetSignatureImageOptions Options for modifying the behavior of the function.
923
+ # @return [File]
924
+ def get_signature_image(account_id, image_type, signature_id, user_id, options = DocuSign_eSign::GetSignatureImageOptions.default)
925
+ data, _status_code, _headers = get_signature_image_with_http_info(account_id, image_type, signature_id, user_id, options)
926
+ return data
927
+ end
928
+
929
+ # Retrieves the user initials image or the user signature image for the specified user.
930
+ # 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&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), 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 \&quot;Bob Smith\&quot; as \&quot;Bob%20Smith\&quot;. ###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
931
+ # @param account_id The external account number (int) or account ID Guid.
932
+ # @param image_type One of **signature_image** or **initials_image**.
933
+ # @param signature_id The ID of the signature being accessed.
934
+ # @param user_id 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.
935
+ # @param DocuSign_eSign::GetSignatureImageOptions Options for modifying the behavior of the function.
936
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
937
+ def get_signature_image_with_http_info(account_id, image_type, signature_id, user_id, options = DocuSign_eSign::GetSignatureImageOptions.default)
938
+ if @api_client.config.debugging
939
+ @api_client.config.logger.debug "Calling API: UsersApi.get_signature_image ..."
940
+ end
941
+ # verify the required parameter 'account_id' is set
942
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.get_signature_image" if account_id.nil?
943
+ # verify the required parameter 'image_type' is set
944
+ fail ArgumentError, "Missing the required parameter 'image_type' when calling UsersApi.get_signature_image" if image_type.nil?
945
+ # verify the required parameter 'signature_id' is set
946
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.get_signature_image" if signature_id.nil?
947
+ # verify the required parameter 'user_id' is set
948
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_signature_image" if user_id.nil?
949
+ # resource path
950
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
951
+
952
+ # query parameters
953
+ query_params = {}
954
+ query_params[:'include_chrome'] = options.include_chrome if !options.include_chrome.nil?
955
+
956
+ # header parameters
957
+ header_params = {}
958
+ # HTTP header 'Accept' (if needed)
959
+ header_params['Accept'] = @api_client.select_header_accept(['image/gif'])
960
+
961
+ # form parameters
962
+ form_params = {}
963
+
964
+ # http body (model)
965
+ post_body = nil
966
+ auth_names = []
967
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
968
+ :header_params => header_params,
969
+ :query_params => query_params,
970
+ :form_params => form_params,
971
+ :body => post_body,
972
+ :auth_names => auth_names,
973
+ :return_type => 'File')
974
+ if @api_client.config.debugging
975
+ @api_client.config.logger.debug "API called: UsersApi#get_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
976
+ end
977
+ return data, status_code, headers
978
+ end
979
+
980
+ # Retrieves the list of users for the specified account.
981
+ # 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
982
+ # @param account_id The external account number (int) or account ID Guid.
983
+ # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
984
+ # @return [UserInformationList]
985
+ def list(account_id, options = DocuSign_eSign::ListOptions.default)
986
+ data, _status_code, _headers = list_with_http_info(account_id, options)
987
+ return data
988
+ end
989
+
990
+ # Retrieves the list of users for the specified account.
991
+ # 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 &#x60;additional_info&#x60; query was added to the endpoint and set to **true**, the full user information is returned for each user
992
+ # @param account_id The external account number (int) or account ID Guid.
993
+ # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
994
+ # @return [Array<(UserInformationList, Fixnum, Hash)>] UserInformationList data, response status code and response headers
995
+ def list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default)
996
+ if @api_client.config.debugging
997
+ @api_client.config.logger.debug "Calling API: UsersApi.list ..."
998
+ end
999
+ # verify the required parameter 'account_id' is set
1000
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.list" if account_id.nil?
1001
+ # resource path
1002
+ local_var_path = "/v2/accounts/{accountId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1003
+
1004
+ # query parameters
1005
+ query_params = {}
1006
+ query_params[:'additional_info'] = options.additional_info if !options.additional_info.nil?
1007
+ query_params[:'count'] = options.count if !options.count.nil?
1008
+ query_params[:'email'] = options.email if !options.email.nil?
1009
+ query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
1010
+ query_params[:'group_id'] = options.group_id if !options.group_id.nil?
1011
+ query_params[:'include_usersettings_for_csv'] = options.include_usersettings_for_csv if !options.include_usersettings_for_csv.nil?
1012
+ query_params[:'login_status'] = options.login_status if !options.login_status.nil?
1013
+ query_params[:'not_group_id'] = options.not_group_id if !options.not_group_id.nil?
1014
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
1015
+ query_params[:'status'] = options.status if !options.status.nil?
1016
+ query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?
1017
+
1018
+ # header parameters
1019
+ header_params = {}
1020
+ # HTTP header 'Accept' (if needed)
1021
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1022
+
1023
+ # form parameters
1024
+ form_params = {}
1025
+
1026
+ # http body (model)
1027
+ post_body = nil
1028
+ auth_names = []
1029
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1030
+ :header_params => header_params,
1031
+ :query_params => query_params,
1032
+ :form_params => form_params,
1033
+ :body => post_body,
1034
+ :auth_names => auth_names,
1035
+ :return_type => 'UserInformationList')
1036
+ if @api_client.config.debugging
1037
+ @api_client.config.logger.debug "API called: UsersApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1038
+ end
1039
+ return data, status_code, headers
1040
+ end
1041
+
1042
+ # Retrieves the custom user settings for a specified user.
1043
+ # 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.
1044
+ # @param account_id The external account number (int) or account ID Guid.
1045
+ # @param user_id 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.
1046
+ # @return [CustomSettingsInformation]
1047
+ def list_custom_settings(account_id, user_id)
1048
+ data, _status_code, _headers = list_custom_settings_with_http_info(account_id, user_id)
1049
+ return data
1050
+ end
1051
+
1052
+ # Retrieves the custom user settings for a specified user.
1053
+ # 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: &#x60;X-DocuSign-User-Settings-Key:group_name&#x60; Where the &#x60;group_name&#x60; 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.
1054
+ # @param account_id The external account number (int) or account ID Guid.
1055
+ # @param user_id 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.
1056
+ # @return [Array<(CustomSettingsInformation, Fixnum, Hash)>] CustomSettingsInformation data, response status code and response headers
1057
+ def list_custom_settings_with_http_info(account_id, user_id)
1058
+ if @api_client.config.debugging
1059
+ @api_client.config.logger.debug "Calling API: UsersApi.list_custom_settings ..."
1060
+ end
1061
+ # verify the required parameter 'account_id' is set
1062
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.list_custom_settings" if account_id.nil?
1063
+ # verify the required parameter 'user_id' is set
1064
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.list_custom_settings" if user_id.nil?
1065
+ # resource path
1066
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/custom_settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1067
+
1068
+ # query parameters
1069
+ query_params = {}
1070
+
1071
+ # header parameters
1072
+ header_params = {}
1073
+ # HTTP header 'Accept' (if needed)
1074
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1075
+
1076
+ # form parameters
1077
+ form_params = {}
1078
+
1079
+ # http body (model)
1080
+ post_body = nil
1081
+ auth_names = []
1082
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1083
+ :header_params => header_params,
1084
+ :query_params => query_params,
1085
+ :form_params => form_params,
1086
+ :body => post_body,
1087
+ :auth_names => auth_names,
1088
+ :return_type => 'CustomSettingsInformation')
1089
+ if @api_client.config.debugging
1090
+ @api_client.config.logger.debug "API called: UsersApi#list_custom_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1091
+ end
1092
+ return data, status_code, headers
1093
+ end
1094
+
1095
+ # Retrieves a list of user signature definitions for a specified user.
1096
+ # 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\".
1097
+ # @param account_id The external account number (int) or account ID Guid.
1098
+ # @param user_id 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.
1099
+ # @return [UserSignaturesInformation]
1100
+ def list_signatures(account_id, user_id)
1101
+ data, _status_code, _headers = list_signatures_with_http_info(account_id, user_id)
1102
+ return data
1103
+ end
1104
+
1105
+ # Retrieves a list of user signature definitions for a specified user.
1106
+ # Retrieves the signature definitions for the specified user. The userId parameter specified in the endpoint must match the authenticated user&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), 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 \&quot;Bob Smith\&quot; as \&quot;Bob%20Smith\&quot;.
1107
+ # @param account_id The external account number (int) or account ID Guid.
1108
+ # @param user_id 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.
1109
+ # @return [Array<(UserSignaturesInformation, Fixnum, Hash)>] UserSignaturesInformation data, response status code and response headers
1110
+ def list_signatures_with_http_info(account_id, user_id)
1111
+ if @api_client.config.debugging
1112
+ @api_client.config.logger.debug "Calling API: UsersApi.list_signatures ..."
1113
+ end
1114
+ # verify the required parameter 'account_id' is set
1115
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.list_signatures" if account_id.nil?
1116
+ # verify the required parameter 'user_id' is set
1117
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.list_signatures" if user_id.nil?
1118
+ # resource path
1119
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1120
+
1121
+ # query parameters
1122
+ query_params = {}
1123
+
1124
+ # header parameters
1125
+ header_params = {}
1126
+ # HTTP header 'Accept' (if needed)
1127
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1128
+
1129
+ # form parameters
1130
+ form_params = {}
1131
+
1132
+ # http body (model)
1133
+ post_body = nil
1134
+ auth_names = []
1135
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1136
+ :header_params => header_params,
1137
+ :query_params => query_params,
1138
+ :form_params => form_params,
1139
+ :body => post_body,
1140
+ :auth_names => auth_names,
1141
+ :return_type => 'UserSignaturesInformation')
1142
+ if @api_client.config.debugging
1143
+ @api_client.config.logger.debug "API called: UsersApi#list_signatures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1144
+ end
1145
+ return data, status_code, headers
1146
+ end
1147
+
1148
+ # Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
1149
+ #
1150
+ # @param account_id The external account number (int) or account ID Guid.
1151
+ # @param contact_mod_request (optional parameter)
1152
+ # @return [ContactUpdateResponse]
1153
+ def post_contacts(account_id, contact_mod_request)
1154
+ data, _status_code, _headers = post_contacts_with_http_info(account_id, contact_mod_request)
1155
+ return data
1156
+ end
1157
+
1158
+ # Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
1159
+ #
1160
+ # @param account_id The external account number (int) or account ID Guid.
1161
+ # @param contact_mod_request (optional parameter)
1162
+ # @return [Array<(ContactUpdateResponse, Fixnum, Hash)>] ContactUpdateResponse data, response status code and response headers
1163
+ def post_contacts_with_http_info(account_id, contact_mod_request)
1164
+ if @api_client.config.debugging
1165
+ @api_client.config.logger.debug "Calling API: UsersApi.post_contacts ..."
1166
+ end
1167
+ # verify the required parameter 'account_id' is set
1168
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.post_contacts" if account_id.nil?
1169
+ # resource path
1170
+ local_var_path = "/v2/accounts/{accountId}/contacts".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1171
+
1172
+ # query parameters
1173
+ query_params = {}
1174
+
1175
+ # header parameters
1176
+ header_params = {}
1177
+ # HTTP header 'Accept' (if needed)
1178
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1179
+
1180
+ # form parameters
1181
+ form_params = {}
1182
+
1183
+ # http body (model)
1184
+ post_body = @api_client.object_to_http_body(contact_mod_request)
1185
+ auth_names = []
1186
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1187
+ :header_params => header_params,
1188
+ :query_params => query_params,
1189
+ :form_params => form_params,
1190
+ :body => post_body,
1191
+ :auth_names => auth_names,
1192
+ :return_type => 'ContactUpdateResponse')
1193
+ if @api_client.config.debugging
1194
+ @api_client.config.logger.debug "API called: UsersApi#post_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1195
+ end
1196
+ return data, status_code, headers
1197
+ end
1198
+
1199
+ # Replaces contacts associated with an account for the DocuSign service.
1200
+ #
1201
+ # @param account_id The external account number (int) or account ID Guid.
1202
+ # @param contact_mod_request (optional parameter)
1203
+ # @return [ContactUpdateResponse]
1204
+ def put_contacts(account_id, contact_mod_request)
1205
+ data, _status_code, _headers = put_contacts_with_http_info(account_id, contact_mod_request)
1206
+ return data
1207
+ end
1208
+
1209
+ # Replaces contacts associated with an account for the DocuSign service.
1210
+ #
1211
+ # @param account_id The external account number (int) or account ID Guid.
1212
+ # @param contact_mod_request (optional parameter)
1213
+ # @return [Array<(ContactUpdateResponse, Fixnum, Hash)>] ContactUpdateResponse data, response status code and response headers
1214
+ def put_contacts_with_http_info(account_id, contact_mod_request)
1215
+ if @api_client.config.debugging
1216
+ @api_client.config.logger.debug "Calling API: UsersApi.put_contacts ..."
1217
+ end
1218
+ # verify the required parameter 'account_id' is set
1219
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.put_contacts" if account_id.nil?
1220
+ # resource path
1221
+ local_var_path = "/v2/accounts/{accountId}/contacts".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1222
+
1223
+ # query parameters
1224
+ query_params = {}
1225
+
1226
+ # header parameters
1227
+ header_params = {}
1228
+ # HTTP header 'Accept' (if needed)
1229
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1230
+
1231
+ # form parameters
1232
+ form_params = {}
1233
+
1234
+ # http body (model)
1235
+ post_body = @api_client.object_to_http_body(contact_mod_request)
1236
+ auth_names = []
1237
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1238
+ :header_params => header_params,
1239
+ :query_params => query_params,
1240
+ :form_params => form_params,
1241
+ :body => post_body,
1242
+ :auth_names => auth_names,
1243
+ :return_type => 'ContactUpdateResponse')
1244
+ if @api_client.config.debugging
1245
+ @api_client.config.logger.debug "API called: UsersApi#put_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1246
+ end
1247
+ return data, status_code, headers
1248
+ end
1249
+
1250
+ # Adds or updates custom user settings for the specified user.
1251
+ # 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.
1252
+ # @param account_id The external account number (int) or account ID Guid.
1253
+ # @param user_id 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.
1254
+ # @param custom_settings_information (optional parameter)
1255
+ # @return [CustomSettingsInformation]
1256
+ def update_custom_settings(account_id, user_id, custom_settings_information)
1257
+ data, _status_code, _headers = update_custom_settings_with_http_info(account_id, user_id, custom_settings_information)
1258
+ return data
1259
+ end
1260
+
1261
+ # Adds or updates custom user settings for the specified user.
1262
+ # 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: &#x60;X-DocuSign-User-Settings-Key:group_name&#x60; Where the &#x60;group_name&#x60; 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.
1263
+ # @param account_id The external account number (int) or account ID Guid.
1264
+ # @param user_id 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.
1265
+ # @param custom_settings_information (optional parameter)
1266
+ # @return [Array<(CustomSettingsInformation, Fixnum, Hash)>] CustomSettingsInformation data, response status code and response headers
1267
+ def update_custom_settings_with_http_info(account_id, user_id, custom_settings_information)
1268
+ if @api_client.config.debugging
1269
+ @api_client.config.logger.debug "Calling API: UsersApi.update_custom_settings ..."
1270
+ end
1271
+ # verify the required parameter 'account_id' is set
1272
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_custom_settings" if account_id.nil?
1273
+ # verify the required parameter 'user_id' is set
1274
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_custom_settings" if user_id.nil?
1275
+ # resource path
1276
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/custom_settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1277
+
1278
+ # query parameters
1279
+ query_params = {}
1280
+
1281
+ # header parameters
1282
+ header_params = {}
1283
+ # HTTP header 'Accept' (if needed)
1284
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1285
+
1286
+ # form parameters
1287
+ form_params = {}
1288
+
1289
+ # http body (model)
1290
+ post_body = @api_client.object_to_http_body(custom_settings_information)
1291
+ auth_names = []
1292
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1293
+ :header_params => header_params,
1294
+ :query_params => query_params,
1295
+ :form_params => form_params,
1296
+ :body => post_body,
1297
+ :auth_names => auth_names,
1298
+ :return_type => 'CustomSettingsInformation')
1299
+ if @api_client.config.debugging
1300
+ @api_client.config.logger.debug "API called: UsersApi#update_custom_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1301
+ end
1302
+ return data, status_code, headers
1303
+ end
1304
+
1305
+ # Updates the user profile information for the specified user.
1306
+ # 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.
1307
+ # @param account_id The external account number (int) or account ID Guid.
1308
+ # @param user_id 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.
1309
+ # @param user_profile (optional parameter)
1310
+ # @return [nil]
1311
+ def update_profile(account_id, user_id, user_profile)
1312
+ update_profile_with_http_info(account_id, user_id, user_profile)
1313
+ return nil
1314
+ end
1315
+
1316
+ # Updates the user profile information for the specified user.
1317
+ # Updates the user&#39;s detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user&#39;s name by changing the information in the &#x60;userDetails&#x60; property. When changing a user&#39;s name, you can either change the information in the &#x60;userName&#x60; property OR change the information in &#x60;firstName&#x60;, &#x60;middleName&#x60;, &#x60;lastName, suffixName&#x60;, and &#x60;title&#x60; properties. Changes to &#x60;firstName&#x60;, &#x60;middleName&#x60;, &#x60;lastName&#x60;, &#x60;suffixName&#x60;, and &#x60;title&#x60; properties take precedence over changes to the &#x60;userName&#x60; property.
1318
+ # @param account_id The external account number (int) or account ID Guid.
1319
+ # @param user_id 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.
1320
+ # @param user_profile (optional parameter)
1321
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1322
+ def update_profile_with_http_info(account_id, user_id, user_profile)
1323
+ if @api_client.config.debugging
1324
+ @api_client.config.logger.debug "Calling API: UsersApi.update_profile ..."
1325
+ end
1326
+ # verify the required parameter 'account_id' is set
1327
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_profile" if account_id.nil?
1328
+ # verify the required parameter 'user_id' is set
1329
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_profile" if user_id.nil?
1330
+ # resource path
1331
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1332
+
1333
+ # query parameters
1334
+ query_params = {}
1335
+
1336
+ # header parameters
1337
+ header_params = {}
1338
+ # HTTP header 'Accept' (if needed)
1339
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1340
+
1341
+ # form parameters
1342
+ form_params = {}
1343
+
1344
+ # http body (model)
1345
+ post_body = @api_client.object_to_http_body(user_profile)
1346
+ auth_names = []
1347
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1348
+ :header_params => header_params,
1349
+ :query_params => query_params,
1350
+ :form_params => form_params,
1351
+ :body => post_body,
1352
+ :auth_names => auth_names)
1353
+ if @api_client.config.debugging
1354
+ @api_client.config.logger.debug "API called: UsersApi#update_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1355
+ end
1356
+ return data, status_code, headers
1357
+ end
1358
+
1359
+ # Updates the user profile image for a specified user.
1360
+ # 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.
1361
+ # @param account_id The external account number (int) or account ID Guid.
1362
+ # @param user_id 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.
1363
+ # @return [nil]
1364
+ def update_profile_image(account_id, user_id)
1365
+ update_profile_image_with_http_info(account_id, user_id)
1366
+ return nil
1367
+ end
1368
+
1369
+ # Updates the user profile image for a specified user.
1370
+ # 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.
1371
+ # @param account_id The external account number (int) or account ID Guid.
1372
+ # @param user_id 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.
1373
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1374
+ def update_profile_image_with_http_info(account_id, user_id)
1375
+ if @api_client.config.debugging
1376
+ @api_client.config.logger.debug "Calling API: UsersApi.update_profile_image ..."
1377
+ end
1378
+ # verify the required parameter 'account_id' is set
1379
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_profile_image" if account_id.nil?
1380
+ # verify the required parameter 'user_id' is set
1381
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_profile_image" if user_id.nil?
1382
+ # resource path
1383
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/profile/image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1384
+
1385
+ # query parameters
1386
+ query_params = {}
1387
+
1388
+ # header parameters
1389
+ header_params = {}
1390
+ # HTTP header 'Accept' (if needed)
1391
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1392
+
1393
+ # form parameters
1394
+ form_params = {}
1395
+
1396
+ # http body (model)
1397
+ post_body = nil
1398
+ auth_names = []
1399
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1400
+ :header_params => header_params,
1401
+ :query_params => query_params,
1402
+ :form_params => form_params,
1403
+ :body => post_body,
1404
+ :auth_names => auth_names)
1405
+ if @api_client.config.debugging
1406
+ @api_client.config.logger.debug "API called: UsersApi#update_profile_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1407
+ end
1408
+ return data, status_code, headers
1409
+ end
1410
+
1411
+ # Updates the user account settings for a specified user.
1412
+ # Updates the account settings list and email notification types for the specified user.
1413
+ # @param account_id The external account number (int) or account ID Guid.
1414
+ # @param user_id 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.
1415
+ # @param user_settings_information (optional parameter)
1416
+ # @return [nil]
1417
+ def update_settings(account_id, user_id, user_settings_information)
1418
+ update_settings_with_http_info(account_id, user_id, user_settings_information)
1419
+ return nil
1420
+ end
1421
+
1422
+ # Updates the user account settings for a specified user.
1423
+ # Updates the account settings list and email notification types for the specified user.
1424
+ # @param account_id The external account number (int) or account ID Guid.
1425
+ # @param user_id 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.
1426
+ # @param user_settings_information (optional parameter)
1427
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1428
+ def update_settings_with_http_info(account_id, user_id, user_settings_information)
1429
+ if @api_client.config.debugging
1430
+ @api_client.config.logger.debug "Calling API: UsersApi.update_settings ..."
1431
+ end
1432
+ # verify the required parameter 'account_id' is set
1433
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_settings" if account_id.nil?
1434
+ # verify the required parameter 'user_id' is set
1435
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_settings" if user_id.nil?
1436
+ # resource path
1437
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1438
+
1439
+ # query parameters
1440
+ query_params = {}
1441
+
1442
+ # header parameters
1443
+ header_params = {}
1444
+ # HTTP header 'Accept' (if needed)
1445
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1446
+
1447
+ # form parameters
1448
+ form_params = {}
1449
+
1450
+ # http body (model)
1451
+ post_body = @api_client.object_to_http_body(user_settings_information)
1452
+ auth_names = []
1453
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1454
+ :header_params => header_params,
1455
+ :query_params => query_params,
1456
+ :form_params => form_params,
1457
+ :body => post_body,
1458
+ :auth_names => auth_names)
1459
+ if @api_client.config.debugging
1460
+ @api_client.config.logger.debug "API called: UsersApi#update_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1461
+ end
1462
+ return data, status_code, headers
1463
+ end
1464
+
1465
+ # Updates the user signature for a specified user.
1466
+ # 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\".
1467
+ # @param account_id The external account number (int) or account ID Guid.
1468
+ # @param signature_id The ID of the signature being accessed.
1469
+ # @param user_id 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.
1470
+ # @param user_signature_definition (optional parameter)
1471
+ # @param DocuSign_eSign::UpdateSignatureOptions Options for modifying the behavior of the function.
1472
+ # @return [UserSignature]
1473
+ def update_signature(account_id, signature_id, user_id, user_signature_definition, options = DocuSign_eSign::UpdateSignatureOptions.default)
1474
+ data, _status_code, _headers = update_signature_with_http_info(account_id, signature_id, user_id, user_signature_definition, options)
1475
+ return data
1476
+ end
1477
+
1478
+ # Updates the user signature for a specified user.
1479
+ # 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&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), 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 \&quot;Bob Smith\&quot; as \&quot;Bob%20Smith\&quot;.
1480
+ # @param account_id The external account number (int) or account ID Guid.
1481
+ # @param signature_id The ID of the signature being accessed.
1482
+ # @param user_id 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.
1483
+ # @param user_signature_definition (optional parameter)
1484
+ # @param DocuSign_eSign::UpdateSignatureOptions Options for modifying the behavior of the function.
1485
+ # @return [Array<(UserSignature, Fixnum, Hash)>] UserSignature data, response status code and response headers
1486
+ def update_signature_with_http_info(account_id, signature_id, user_id, user_signature_definition, options = DocuSign_eSign::UpdateSignatureOptions.default)
1487
+ if @api_client.config.debugging
1488
+ @api_client.config.logger.debug "Calling API: UsersApi.update_signature ..."
1489
+ end
1490
+ # verify the required parameter 'account_id' is set
1491
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_signature" if account_id.nil?
1492
+ # verify the required parameter 'signature_id' is set
1493
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.update_signature" if signature_id.nil?
1494
+ # verify the required parameter 'user_id' is set
1495
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_signature" if user_id.nil?
1496
+ # resource path
1497
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1498
+
1499
+ # query parameters
1500
+ query_params = {}
1501
+ query_params[:'close_existing_signature'] = options.close_existing_signature if !options.close_existing_signature.nil?
1502
+
1503
+ # header parameters
1504
+ header_params = {}
1505
+ # HTTP header 'Accept' (if needed)
1506
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1507
+
1508
+ # form parameters
1509
+ form_params = {}
1510
+
1511
+ # http body (model)
1512
+ post_body = @api_client.object_to_http_body(user_signature_definition)
1513
+ auth_names = []
1514
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1515
+ :header_params => header_params,
1516
+ :query_params => query_params,
1517
+ :form_params => form_params,
1518
+ :body => post_body,
1519
+ :auth_names => auth_names,
1520
+ :return_type => 'UserSignature')
1521
+ if @api_client.config.debugging
1522
+ @api_client.config.logger.debug "API called: UsersApi#update_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1523
+ end
1524
+ return data, status_code, headers
1525
+ end
1526
+
1527
+ # Updates the user signature image or user initials image for the specified user.
1528
+ # 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\".
1529
+ # @param account_id The external account number (int) or account ID Guid.
1530
+ # @param image_type One of **signature_image** or **initials_image**.
1531
+ # @param signature_id The ID of the signature being accessed.
1532
+ # @param user_id 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.
1533
+ # @return [UserSignature]
1534
+ def update_signature_image(account_id, image_type, signature_id, user_id)
1535
+ data, _status_code, _headers = update_signature_image_with_http_info(account_id, image_type, signature_id, user_id)
1536
+ return data
1537
+ end
1538
+
1539
+ # Updates the user signature image or user initials image for the specified user.
1540
+ # 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&#39;s user ID and the user must be a member of the account. The &#x60;signatureId&#x60; parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (&#x60;signatureId&#x60;), 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 \&quot;Bob Smith\&quot; as \&quot;Bob%20Smith\&quot;.
1541
+ # @param account_id The external account number (int) or account ID Guid.
1542
+ # @param image_type One of **signature_image** or **initials_image**.
1543
+ # @param signature_id The ID of the signature being accessed.
1544
+ # @param user_id 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.
1545
+ # @return [Array<(UserSignature, Fixnum, Hash)>] UserSignature data, response status code and response headers
1546
+ def update_signature_image_with_http_info(account_id, image_type, signature_id, user_id)
1547
+ if @api_client.config.debugging
1548
+ @api_client.config.logger.debug "Calling API: UsersApi.update_signature_image ..."
1549
+ end
1550
+ # verify the required parameter 'account_id' is set
1551
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_signature_image" if account_id.nil?
1552
+ # verify the required parameter 'image_type' is set
1553
+ fail ArgumentError, "Missing the required parameter 'image_type' when calling UsersApi.update_signature_image" if image_type.nil?
1554
+ # verify the required parameter 'signature_id' is set
1555
+ fail ArgumentError, "Missing the required parameter 'signature_id' when calling UsersApi.update_signature_image" if signature_id.nil?
1556
+ # verify the required parameter 'user_id' is set
1557
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_signature_image" if user_id.nil?
1558
+ # resource path
1559
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'imageType' + '}', image_type.to_s).sub('{' + 'signatureId' + '}', signature_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1560
+
1561
+ # query parameters
1562
+ query_params = {}
1563
+
1564
+ # header parameters
1565
+ header_params = {}
1566
+ # HTTP header 'Accept' (if needed)
1567
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1568
+
1569
+ # form parameters
1570
+ form_params = {}
1571
+
1572
+ # http body (model)
1573
+ post_body = nil
1574
+ auth_names = []
1575
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1576
+ :header_params => header_params,
1577
+ :query_params => query_params,
1578
+ :form_params => form_params,
1579
+ :body => post_body,
1580
+ :auth_names => auth_names,
1581
+ :return_type => 'UserSignature')
1582
+ if @api_client.config.debugging
1583
+ @api_client.config.logger.debug "API called: UsersApi#update_signature_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1584
+ end
1585
+ return data, status_code, headers
1586
+ end
1587
+
1588
+ # Updates the specified user information.
1589
+ #
1590
+ # @param account_id The external account number (int) or account ID Guid.
1591
+ # @param user_id 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.
1592
+ # @param user_information (optional parameter)
1593
+ # @return [UserInformation]
1594
+ def update_user(account_id, user_id, user_information)
1595
+ data, _status_code, _headers = update_user_with_http_info(account_id, user_id, user_information)
1596
+ return data
1597
+ end
1598
+
1599
+ # Updates the specified user information.
1600
+ #
1601
+ # @param account_id The external account number (int) or account ID Guid.
1602
+ # @param user_id 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.
1603
+ # @param user_information (optional parameter)
1604
+ # @return [Array<(UserInformation, Fixnum, Hash)>] UserInformation data, response status code and response headers
1605
+ def update_user_with_http_info(account_id, user_id, user_information)
1606
+ if @api_client.config.debugging
1607
+ @api_client.config.logger.debug "Calling API: UsersApi.update_user ..."
1608
+ end
1609
+ # verify the required parameter 'account_id' is set
1610
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_user" if account_id.nil?
1611
+ # verify the required parameter 'user_id' is set
1612
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_user" if user_id.nil?
1613
+ # resource path
1614
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1615
+
1616
+ # query parameters
1617
+ query_params = {}
1618
+
1619
+ # header parameters
1620
+ header_params = {}
1621
+ # HTTP header 'Accept' (if needed)
1622
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1623
+
1624
+ # form parameters
1625
+ form_params = {}
1626
+
1627
+ # http body (model)
1628
+ post_body = @api_client.object_to_http_body(user_information)
1629
+ auth_names = []
1630
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1631
+ :header_params => header_params,
1632
+ :query_params => query_params,
1633
+ :form_params => form_params,
1634
+ :body => post_body,
1635
+ :auth_names => auth_names,
1636
+ :return_type => 'UserInformation')
1637
+ if @api_client.config.debugging
1638
+ @api_client.config.logger.debug "API called: UsersApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1639
+ end
1640
+ return data, status_code, headers
1641
+ end
1642
+
1643
+ # Change one or more user in the specified account.
1644
+ #
1645
+ # @param account_id The external account number (int) or account ID Guid.
1646
+ # @param user_information_list (optional parameter)
1647
+ # @return [UserInformationList]
1648
+ def update_users(account_id, user_information_list)
1649
+ data, _status_code, _headers = update_users_with_http_info(account_id, user_information_list)
1650
+ return data
1651
+ end
1652
+
1653
+ # Change one or more user in the specified account.
1654
+ #
1655
+ # @param account_id The external account number (int) or account ID Guid.
1656
+ # @param user_information_list (optional parameter)
1657
+ # @return [Array<(UserInformationList, Fixnum, Hash)>] UserInformationList data, response status code and response headers
1658
+ def update_users_with_http_info(account_id, user_information_list)
1659
+ if @api_client.config.debugging
1660
+ @api_client.config.logger.debug "Calling API: UsersApi.update_users ..."
1661
+ end
1662
+ # verify the required parameter 'account_id' is set
1663
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling UsersApi.update_users" if account_id.nil?
1664
+ # resource path
1665
+ local_var_path = "/v2/accounts/{accountId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
1666
+
1667
+ # query parameters
1668
+ query_params = {}
1669
+
1670
+ # header parameters
1671
+ header_params = {}
1672
+ # HTTP header 'Accept' (if needed)
1673
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1674
+
1675
+ # form parameters
1676
+ form_params = {}
1677
+
1678
+ # http body (model)
1679
+ post_body = @api_client.object_to_http_body(user_information_list)
1680
+ auth_names = []
1681
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1682
+ :header_params => header_params,
1683
+ :query_params => query_params,
1684
+ :form_params => form_params,
1685
+ :body => post_body,
1686
+ :auth_names => auth_names,
1687
+ :return_type => 'UserInformationList')
1688
+ if @api_client.config.debugging
1689
+ @api_client.config.logger.debug "API called: UsersApi#update_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1690
+ end
1691
+ return data, status_code, headers
1692
+ end
1693
+ end
1694
+ end