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,393 @@
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 LoginOptions
17
+ # When set to **true**, shows the account API password in the response.
18
+ attr_accessor :api_password
19
+
20
+ #
21
+ attr_accessor :embed_account_id_guid
22
+
23
+ # When set to **true**, shows the account ID GUID in the response.
24
+ attr_accessor :include_account_id_guid
25
+
26
+ # Determines whether login settings are returned in the response. Valid Values: * all - All the login settings are returned. * none - no login settings are returned.
27
+ attr_accessor :login_settings
28
+
29
+ def self.default
30
+ @@default ||= LoginOptions.new
31
+ end
32
+ end
33
+
34
+
35
+ class AuthenticationApi
36
+ attr_accessor :api_client
37
+
38
+ def initialize(api_client = AuthenticationApi.default)
39
+ @api_client = api_client
40
+ end
41
+
42
+ # Deletes user's social account.
43
+ # Deletes a social account from a use's account.
44
+ # @param account_id The external account number (int) or account ID Guid.
45
+ # @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.
46
+ # @param social_account_information (optional parameter)
47
+ # @return [nil]
48
+ def delete_social_login(account_id, user_id, social_account_information)
49
+ delete_social_login_with_http_info(account_id, user_id, social_account_information)
50
+ return nil
51
+ end
52
+
53
+ # Deletes user's social account.
54
+ # Deletes a social account from a use's account.
55
+ # @param account_id The external account number (int) or account ID Guid.
56
+ # @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.
57
+ # @param social_account_information (optional parameter)
58
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
59
+ def delete_social_login_with_http_info(account_id, user_id, social_account_information)
60
+ if @api_client.config.debugging
61
+ @api_client.config.logger.debug "Calling API: AuthenticationApi.delete_social_login ..."
62
+ end
63
+ # verify the required parameter 'account_id' is set
64
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AuthenticationApi.delete_social_login" if account_id.nil?
65
+ # verify the required parameter 'user_id' is set
66
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthenticationApi.delete_social_login" if user_id.nil?
67
+ # resource path
68
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/social".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
69
+
70
+ # query parameters
71
+ query_params = {}
72
+
73
+ # header parameters
74
+ header_params = {}
75
+ # HTTP header 'Accept' (if needed)
76
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
77
+
78
+ # form parameters
79
+ form_params = {}
80
+
81
+ # http body (model)
82
+ post_body = @api_client.object_to_http_body(social_account_information)
83
+ auth_names = []
84
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
85
+ :header_params => header_params,
86
+ :query_params => query_params,
87
+ :form_params => form_params,
88
+ :body => post_body,
89
+ :auth_names => auth_names)
90
+ if @api_client.config.debugging
91
+ @api_client.config.logger.debug "API called: AuthenticationApi#delete_social_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
92
+ end
93
+ return data, status_code, headers
94
+ end
95
+
96
+ # Creates an authorization token.
97
+ # Creates an OAuth2 authorization server token endpoint.
98
+ # @return [OauthAccess]
99
+ def get_o_auth_token()
100
+ data, _status_code, _headers = get_o_auth_token_with_http_info()
101
+ return data
102
+ end
103
+
104
+ # Creates an authorization token.
105
+ # Creates an OAuth2 authorization server token endpoint.
106
+ # @return [Array<(OauthAccess, Fixnum, Hash)>] OauthAccess data, response status code and response headers
107
+ def get_o_auth_token_with_http_info()
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug "Calling API: AuthenticationApi.get_o_auth_token ..."
110
+ end
111
+ # resource path
112
+ local_var_path = "/v2/oauth2/token".sub('{format}','json')
113
+
114
+ # query parameters
115
+ query_params = {}
116
+
117
+ # header parameters
118
+ header_params = {}
119
+ # HTTP header 'Accept' (if needed)
120
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
121
+
122
+ # form parameters
123
+ form_params = {}
124
+
125
+ # http body (model)
126
+ post_body = nil
127
+ auth_names = []
128
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
129
+ :header_params => header_params,
130
+ :query_params => query_params,
131
+ :form_params => form_params,
132
+ :body => post_body,
133
+ :auth_names => auth_names,
134
+ :return_type => 'OauthAccess')
135
+ if @api_client.config.debugging
136
+ @api_client.config.logger.debug "API called: AuthenticationApi#get_o_auth_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
137
+ end
138
+ return data, status_code, headers
139
+ end
140
+
141
+ # Gets a list of a user's social accounts.
142
+ # Retrieves a list of social accounts linked to a user's account.
143
+ # @param account_id The external account number (int) or account ID Guid.
144
+ # @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.
145
+ # @return [UserSocialIdResult]
146
+ def list_social_logins(account_id, user_id)
147
+ data, _status_code, _headers = list_social_logins_with_http_info(account_id, user_id)
148
+ return data
149
+ end
150
+
151
+ # Gets a list of a user&#39;s social accounts.
152
+ # Retrieves a list of social accounts linked to a user&#39;s account.
153
+ # @param account_id The external account number (int) or account ID Guid.
154
+ # @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.
155
+ # @return [Array<(UserSocialIdResult, Fixnum, Hash)>] UserSocialIdResult data, response status code and response headers
156
+ def list_social_logins_with_http_info(account_id, user_id)
157
+ if @api_client.config.debugging
158
+ @api_client.config.logger.debug "Calling API: AuthenticationApi.list_social_logins ..."
159
+ end
160
+ # verify the required parameter 'account_id' is set
161
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AuthenticationApi.list_social_logins" if account_id.nil?
162
+ # verify the required parameter 'user_id' is set
163
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthenticationApi.list_social_logins" if user_id.nil?
164
+ # resource path
165
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/social".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
166
+
167
+ # query parameters
168
+ query_params = {}
169
+
170
+ # header parameters
171
+ header_params = {}
172
+ # HTTP header 'Accept' (if needed)
173
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
174
+
175
+ # form parameters
176
+ form_params = {}
177
+
178
+ # http body (model)
179
+ post_body = nil
180
+ auth_names = []
181
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
182
+ :header_params => header_params,
183
+ :query_params => query_params,
184
+ :form_params => form_params,
185
+ :body => post_body,
186
+ :auth_names => auth_names,
187
+ :return_type => 'UserSocialIdResult')
188
+ if @api_client.config.debugging
189
+ @api_client.config.logger.debug "API called: AuthenticationApi#list_social_logins\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
190
+ end
191
+ return data, status_code, headers
192
+ end
193
+
194
+ # Gets login information for a specified user.
195
+ # Retrieves login information for a specified user. Each account that is associated with the login credentials is listed. You can use the returned information to determine whether a user is authenticated and select an account to use in future operations. The `baseUrl` property, returned in the response, is used in all future API calls as the base of the request URL. The `baseUrl` property contains the DocuSign server, the API version, and the `accountId` property that is used for the login. This request uses your DocuSign credentials to retrieve the account information.
196
+ # @param DocuSign_eSign::LoginOptions Options for modifying the behavior of the function.
197
+ # @return [LoginInformation]
198
+ def login(options = DocuSign_eSign::LoginOptions.default)
199
+ data, _status_code, _headers = login_with_http_info(options)
200
+ return data
201
+ end
202
+
203
+ # Gets login information for a specified user.
204
+ # Retrieves login information for a specified user. Each account that is associated with the login credentials is listed. You can use the returned information to determine whether a user is authenticated and select an account to use in future operations. The &#x60;baseUrl&#x60; property, returned in the response, is used in all future API calls as the base of the request URL. The &#x60;baseUrl&#x60; property contains the DocuSign server, the API version, and the &#x60;accountId&#x60; property that is used for the login. This request uses your DocuSign credentials to retrieve the account information.
205
+ # @param DocuSign_eSign::LoginOptions Options for modifying the behavior of the function.
206
+ # @return [Array<(LoginInformation, Fixnum, Hash)>] LoginInformation data, response status code and response headers
207
+ def login_with_http_info(options = DocuSign_eSign::LoginOptions.default)
208
+ if @api_client.config.debugging
209
+ @api_client.config.logger.debug "Calling API: AuthenticationApi.login ..."
210
+ end
211
+ # resource path
212
+ local_var_path = "/v2/login_information".sub('{format}','json')
213
+
214
+ # query parameters
215
+ query_params = {}
216
+ query_params[:'api_password'] = options.api_password if !options.api_password.nil?
217
+ query_params[:'embed_account_id_guid'] = options.embed_account_id_guid if !options.embed_account_id_guid.nil?
218
+ query_params[:'include_account_id_guid'] = options.include_account_id_guid if !options.include_account_id_guid.nil?
219
+ query_params[:'login_settings'] = options.login_settings if !options.login_settings.nil?
220
+
221
+ # header parameters
222
+ header_params = {}
223
+ # HTTP header 'Accept' (if needed)
224
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
225
+
226
+ # form parameters
227
+ form_params = {}
228
+
229
+ # http body (model)
230
+ post_body = nil
231
+ auth_names = []
232
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
233
+ :header_params => header_params,
234
+ :query_params => query_params,
235
+ :form_params => form_params,
236
+ :body => post_body,
237
+ :auth_names => auth_names,
238
+ :return_type => 'LoginInformation')
239
+ if @api_client.config.debugging
240
+ @api_client.config.logger.debug "API called: AuthenticationApi#login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
241
+ end
242
+ return data, status_code, headers
243
+ end
244
+
245
+ # Revokes an authorization token.
246
+ # Revokes an OAuth2 authorization server token. After the revocation is complete, a caller must re-authenticate to restore access.
247
+ # @return [nil]
248
+ def revoke_o_auth_token()
249
+ revoke_o_auth_token_with_http_info()
250
+ return nil
251
+ end
252
+
253
+ # Revokes an authorization token.
254
+ # Revokes an OAuth2 authorization server token. After the revocation is complete, a caller must re-authenticate to restore access.
255
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
256
+ def revoke_o_auth_token_with_http_info()
257
+ if @api_client.config.debugging
258
+ @api_client.config.logger.debug "Calling API: AuthenticationApi.revoke_o_auth_token ..."
259
+ end
260
+ # resource path
261
+ local_var_path = "/v2/oauth2/revoke".sub('{format}','json')
262
+
263
+ # query parameters
264
+ query_params = {}
265
+
266
+ # header parameters
267
+ header_params = {}
268
+ # HTTP header 'Accept' (if needed)
269
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
270
+
271
+ # form parameters
272
+ form_params = {}
273
+
274
+ # http body (model)
275
+ post_body = nil
276
+ auth_names = []
277
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
278
+ :header_params => header_params,
279
+ :query_params => query_params,
280
+ :form_params => form_params,
281
+ :body => post_body,
282
+ :auth_names => auth_names)
283
+ if @api_client.config.debugging
284
+ @api_client.config.logger.debug "API called: AuthenticationApi#revoke_o_auth_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
285
+ end
286
+ return data, status_code, headers
287
+ end
288
+
289
+ # Updates the password for a specified user.
290
+ # Updates the password for a specified user.
291
+ # @param login_part Currently, only the value **password** is supported.
292
+ # @param user_password_information (optional parameter)
293
+ # @return [nil]
294
+ def update_password(login_part, user_password_information)
295
+ update_password_with_http_info(login_part, user_password_information)
296
+ return nil
297
+ end
298
+
299
+ # Updates the password for a specified user.
300
+ # Updates the password for a specified user.
301
+ # @param login_part Currently, only the value **password** is supported.
302
+ # @param user_password_information (optional parameter)
303
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
304
+ def update_password_with_http_info(login_part, user_password_information)
305
+ if @api_client.config.debugging
306
+ @api_client.config.logger.debug "Calling API: AuthenticationApi.update_password ..."
307
+ end
308
+ # verify the required parameter 'login_part' is set
309
+ fail ArgumentError, "Missing the required parameter 'login_part' when calling AuthenticationApi.update_password" if login_part.nil?
310
+ # resource path
311
+ local_var_path = "/v2/login_information/{loginPart}".sub('{format}','json').sub('{' + 'loginPart' + '}', login_part.to_s)
312
+
313
+ # query parameters
314
+ query_params = {}
315
+
316
+ # header parameters
317
+ header_params = {}
318
+ # HTTP header 'Accept' (if needed)
319
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
320
+
321
+ # form parameters
322
+ form_params = {}
323
+
324
+ # http body (model)
325
+ post_body = @api_client.object_to_http_body(user_password_information)
326
+ auth_names = []
327
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
328
+ :header_params => header_params,
329
+ :query_params => query_params,
330
+ :form_params => form_params,
331
+ :body => post_body,
332
+ :auth_names => auth_names)
333
+ if @api_client.config.debugging
334
+ @api_client.config.logger.debug "API called: AuthenticationApi#update_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
335
+ end
336
+ return data, status_code, headers
337
+ end
338
+
339
+ # Adds social account for a user.
340
+ # Adds a new social account to a user's account.
341
+ # @param account_id The external account number (int) or account ID Guid.
342
+ # @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.
343
+ # @param social_account_information (optional parameter)
344
+ # @return [nil]
345
+ def update_social_login(account_id, user_id, social_account_information)
346
+ update_social_login_with_http_info(account_id, user_id, social_account_information)
347
+ return nil
348
+ end
349
+
350
+ # Adds social account for a user.
351
+ # Adds a new social account to a user&#39;s account.
352
+ # @param account_id The external account number (int) or account ID Guid.
353
+ # @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.
354
+ # @param social_account_information (optional parameter)
355
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
356
+ def update_social_login_with_http_info(account_id, user_id, social_account_information)
357
+ if @api_client.config.debugging
358
+ @api_client.config.logger.debug "Calling API: AuthenticationApi.update_social_login ..."
359
+ end
360
+ # verify the required parameter 'account_id' is set
361
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AuthenticationApi.update_social_login" if account_id.nil?
362
+ # verify the required parameter 'user_id' is set
363
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthenticationApi.update_social_login" if user_id.nil?
364
+ # resource path
365
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/social".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
366
+
367
+ # query parameters
368
+ query_params = {}
369
+
370
+ # header parameters
371
+ header_params = {}
372
+ # HTTP header 'Accept' (if needed)
373
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
374
+
375
+ # form parameters
376
+ form_params = {}
377
+
378
+ # http body (model)
379
+ post_body = @api_client.object_to_http_body(social_account_information)
380
+ auth_names = []
381
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
382
+ :header_params => header_params,
383
+ :query_params => query_params,
384
+ :form_params => form_params,
385
+ :body => post_body,
386
+ :auth_names => auth_names)
387
+ if @api_client.config.debugging
388
+ @api_client.config.logger.debug "API called: AuthenticationApi#update_social_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
389
+ end
390
+ return data, status_code, headers
391
+ end
392
+ end
393
+ end
@@ -0,0 +1,636 @@
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 GetPlanOptions
17
+ # When set to **true**, excludes credit card information from the response.
18
+ attr_accessor :include_credit_card_information
19
+
20
+ # When set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information.
21
+ attr_accessor :include_metadata
22
+
23
+ # When set to **true**, excludes successor information from the response.
24
+ attr_accessor :include_successor_plans
25
+
26
+ def self.default
27
+ @@default ||= GetPlanOptions.new
28
+ end
29
+ end
30
+
31
+ class ListInvoicesOptions
32
+ # Specifies the date/time of the earliest invoice in the account to retrieve.
33
+ attr_accessor :from_date
34
+
35
+ # Specifies the date/time of the latest invoice in the account to retrieve.
36
+ attr_accessor :to_date
37
+
38
+ def self.default
39
+ @@default ||= ListInvoicesOptions.new
40
+ end
41
+ end
42
+
43
+ class ListPaymentsOptions
44
+ # Specifies the date/time of the earliest payment in the account to retrieve.
45
+ attr_accessor :from_date
46
+
47
+ # Specifies the date/time of the latest payment in the account to retrieve.
48
+ attr_accessor :to_date
49
+
50
+ def self.default
51
+ @@default ||= ListPaymentsOptions.new
52
+ end
53
+ end
54
+
55
+ class UpdatePlanOptions
56
+ # When set to **true**, updates the account using a preview billing plan.
57
+ attr_accessor :preview_billing_plan
58
+
59
+ def self.default
60
+ @@default ||= UpdatePlanOptions.new
61
+ end
62
+ end
63
+
64
+
65
+ class BillingApi
66
+ attr_accessor :api_client
67
+
68
+ def initialize(api_client = BillingApi.default)
69
+ @api_client = api_client
70
+ end
71
+
72
+ # Get the billing plan details.
73
+ # Retrieves the billing plan details for the specified billing plan ID.
74
+ # @param billing_plan_id The ID of the billing plan being accessed.
75
+ # @return [BillingPlanResponse]
76
+ def get_billing_plan(billing_plan_id)
77
+ data, _status_code, _headers = get_billing_plan_with_http_info(billing_plan_id)
78
+ return data
79
+ end
80
+
81
+ # Get the billing plan details.
82
+ # Retrieves the billing plan details for the specified billing plan ID.
83
+ # @param billing_plan_id The ID of the billing plan being accessed.
84
+ # @return [Array<(BillingPlanResponse, Fixnum, Hash)>] BillingPlanResponse data, response status code and response headers
85
+ def get_billing_plan_with_http_info(billing_plan_id)
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug "Calling API: BillingApi.get_billing_plan ..."
88
+ end
89
+ # verify the required parameter 'billing_plan_id' is set
90
+ fail ArgumentError, "Missing the required parameter 'billing_plan_id' when calling BillingApi.get_billing_plan" if billing_plan_id.nil?
91
+ # resource path
92
+ local_var_path = "/v2/billing_plans/{billingPlanId}".sub('{format}','json').sub('{' + 'billingPlanId' + '}', billing_plan_id.to_s)
93
+
94
+ # query parameters
95
+ query_params = {}
96
+
97
+ # header parameters
98
+ header_params = {}
99
+ # HTTP header 'Accept' (if needed)
100
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
101
+
102
+ # form parameters
103
+ form_params = {}
104
+
105
+ # http body (model)
106
+ post_body = nil
107
+ auth_names = []
108
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
109
+ :header_params => header_params,
110
+ :query_params => query_params,
111
+ :form_params => form_params,
112
+ :body => post_body,
113
+ :auth_names => auth_names,
114
+ :return_type => 'BillingPlanResponse')
115
+ if @api_client.config.debugging
116
+ @api_client.config.logger.debug "API called: BillingApi#get_billing_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
117
+ end
118
+ return data, status_code, headers
119
+ end
120
+
121
+ # Retrieves a billing invoice.
122
+ # Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as ‘unlimited’ or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
123
+ # @param account_id The external account number (int) or account ID Guid.
124
+ # @param invoice_id
125
+ # @return [BillingInvoice]
126
+ def get_invoice(account_id, invoice_id)
127
+ data, _status_code, _headers = get_invoice_with_http_info(account_id, invoice_id)
128
+ return data
129
+ end
130
+
131
+ # Retrieves a billing invoice.
132
+ # Retrieves the specified invoice. ###### Note: If the &#x60;pdfAvailable&#x60; property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the &#x60;Accept&#x60; property in the header to &#x60;Accept: application/pdf&#x60;. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as ‘unlimited’ or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different &#x60;chargeName&#x60; property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
133
+ # @param account_id The external account number (int) or account ID Guid.
134
+ # @param invoice_id
135
+ # @return [Array<(BillingInvoice, Fixnum, Hash)>] BillingInvoice data, response status code and response headers
136
+ def get_invoice_with_http_info(account_id, invoice_id)
137
+ if @api_client.config.debugging
138
+ @api_client.config.logger.debug "Calling API: BillingApi.get_invoice ..."
139
+ end
140
+ # verify the required parameter 'account_id' is set
141
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_invoice" if account_id.nil?
142
+ # verify the required parameter 'invoice_id' is set
143
+ fail ArgumentError, "Missing the required parameter 'invoice_id' when calling BillingApi.get_invoice" if invoice_id.nil?
144
+ # resource path
145
+ local_var_path = "/v2/accounts/{accountId}/billing_invoices/{invoiceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'invoiceId' + '}', invoice_id.to_s)
146
+
147
+ # query parameters
148
+ query_params = {}
149
+
150
+ # header parameters
151
+ header_params = {}
152
+ # HTTP header 'Accept' (if needed)
153
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
154
+
155
+ # form parameters
156
+ form_params = {}
157
+
158
+ # http body (model)
159
+ post_body = nil
160
+ auth_names = []
161
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
162
+ :header_params => header_params,
163
+ :query_params => query_params,
164
+ :form_params => form_params,
165
+ :body => post_body,
166
+ :auth_names => auth_names,
167
+ :return_type => 'BillingInvoice')
168
+ if @api_client.config.debugging
169
+ @api_client.config.logger.debug "API called: BillingApi#get_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
170
+ end
171
+ return data, status_code, headers
172
+ end
173
+
174
+ # Gets billing payment information for a specific payment.
175
+ # Retrieves the information for a specified payment. Privileges required: account administrator
176
+ # @param account_id The external account number (int) or account ID Guid.
177
+ # @param payment_id
178
+ # @return [BillingPaymentItem]
179
+ def get_payment(account_id, payment_id)
180
+ data, _status_code, _headers = get_payment_with_http_info(account_id, payment_id)
181
+ return data
182
+ end
183
+
184
+ # Gets billing payment information for a specific payment.
185
+ # Retrieves the information for a specified payment. Privileges required: account administrator
186
+ # @param account_id The external account number (int) or account ID Guid.
187
+ # @param payment_id
188
+ # @return [Array<(BillingPaymentItem, Fixnum, Hash)>] BillingPaymentItem data, response status code and response headers
189
+ def get_payment_with_http_info(account_id, payment_id)
190
+ if @api_client.config.debugging
191
+ @api_client.config.logger.debug "Calling API: BillingApi.get_payment ..."
192
+ end
193
+ # verify the required parameter 'account_id' is set
194
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_payment" if account_id.nil?
195
+ # verify the required parameter 'payment_id' is set
196
+ fail ArgumentError, "Missing the required parameter 'payment_id' when calling BillingApi.get_payment" if payment_id.nil?
197
+ # resource path
198
+ local_var_path = "/v2/accounts/{accountId}/billing_payments/{paymentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'paymentId' + '}', payment_id.to_s)
199
+
200
+ # query parameters
201
+ query_params = {}
202
+
203
+ # header parameters
204
+ header_params = {}
205
+ # HTTP header 'Accept' (if needed)
206
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
207
+
208
+ # form parameters
209
+ form_params = {}
210
+
211
+ # http body (model)
212
+ post_body = nil
213
+ auth_names = []
214
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
215
+ :header_params => header_params,
216
+ :query_params => query_params,
217
+ :form_params => form_params,
218
+ :body => post_body,
219
+ :auth_names => auth_names,
220
+ :return_type => 'BillingPaymentItem')
221
+ if @api_client.config.debugging
222
+ @api_client.config.logger.debug "API called: BillingApi#get_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
223
+ end
224
+ return data, status_code, headers
225
+ end
226
+
227
+ # Get Account Billing Plan
228
+ # Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the `setting` set to **false**. Response The response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [ML:Update Billing Plan] reference. ###### Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible.
229
+ # @param account_id The external account number (int) or account ID Guid.
230
+ # @param DocuSign_eSign::GetPlanOptions Options for modifying the behavior of the function.
231
+ # @return [AccountBillingPlanResponse]
232
+ def get_plan(account_id, options = DocuSign_eSign::GetPlanOptions.default)
233
+ data, _status_code, _headers = get_plan_with_http_info(account_id, options)
234
+ return data
235
+ end
236
+
237
+ # Get Account Billing Plan
238
+ # Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the &#x60;setting&#x60; set to **false**. Response The response returns the billing plan information, including the currency code, for the plan. The &#x60;billingPlan&#x60; and &#x60;succesorPlans&#x60; property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the &#x60;billingAddress&#x60; and &#x60;creditCardInformation&#x60; property values are the same as those shown in the [ML:Update Billing Plan] reference. ###### Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible.
239
+ # @param account_id The external account number (int) or account ID Guid.
240
+ # @param DocuSign_eSign::GetPlanOptions Options for modifying the behavior of the function.
241
+ # @return [Array<(AccountBillingPlanResponse, Fixnum, Hash)>] AccountBillingPlanResponse data, response status code and response headers
242
+ def get_plan_with_http_info(account_id, options = DocuSign_eSign::GetPlanOptions.default)
243
+ if @api_client.config.debugging
244
+ @api_client.config.logger.debug "Calling API: BillingApi.get_plan ..."
245
+ end
246
+ # verify the required parameter 'account_id' is set
247
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_plan" if account_id.nil?
248
+ # resource path
249
+ local_var_path = "/v2/accounts/{accountId}/billing_plan".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
250
+
251
+ # query parameters
252
+ query_params = {}
253
+ query_params[:'include_credit_card_information'] = options.include_credit_card_information if !options.include_credit_card_information.nil?
254
+ query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
255
+ query_params[:'include_successor_plans'] = options.include_successor_plans if !options.include_successor_plans.nil?
256
+
257
+ # header parameters
258
+ header_params = {}
259
+ # HTTP header 'Accept' (if needed)
260
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
261
+
262
+ # form parameters
263
+ form_params = {}
264
+
265
+ # http body (model)
266
+ post_body = nil
267
+ auth_names = []
268
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
269
+ :header_params => header_params,
270
+ :query_params => query_params,
271
+ :form_params => form_params,
272
+ :body => post_body,
273
+ :auth_names => auth_names,
274
+ :return_type => 'AccountBillingPlanResponse')
275
+ if @api_client.config.debugging
276
+ @api_client.config.logger.debug "API called: BillingApi#get_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
277
+ end
278
+ return data, status_code, headers
279
+ end
280
+
281
+ # Gets the list of available billing plans.
282
+ # Retrieves a list of the billing plans associated with a distributor.
283
+ # @return [BillingPlansResponse]
284
+ def list_billing_plans()
285
+ data, _status_code, _headers = list_billing_plans_with_http_info()
286
+ return data
287
+ end
288
+
289
+ # Gets the list of available billing plans.
290
+ # Retrieves a list of the billing plans associated with a distributor.
291
+ # @return [Array<(BillingPlansResponse, Fixnum, Hash)>] BillingPlansResponse data, response status code and response headers
292
+ def list_billing_plans_with_http_info()
293
+ if @api_client.config.debugging
294
+ @api_client.config.logger.debug "Calling API: BillingApi.list_billing_plans ..."
295
+ end
296
+ # resource path
297
+ local_var_path = "/v2/billing_plans".sub('{format}','json')
298
+
299
+ # query parameters
300
+ query_params = {}
301
+
302
+ # header parameters
303
+ header_params = {}
304
+ # HTTP header 'Accept' (if needed)
305
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
306
+
307
+ # form parameters
308
+ form_params = {}
309
+
310
+ # http body (model)
311
+ post_body = nil
312
+ auth_names = []
313
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
314
+ :header_params => header_params,
315
+ :query_params => query_params,
316
+ :form_params => form_params,
317
+ :body => post_body,
318
+ :auth_names => auth_names,
319
+ :return_type => 'BillingPlansResponse')
320
+ if @api_client.config.debugging
321
+ @api_client.config.logger.debug "API called: BillingApi#list_billing_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
322
+ end
323
+ return data, status_code, headers
324
+ end
325
+
326
+ # Get a List of Billing Invoices
327
+ # Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator
328
+ # @param account_id The external account number (int) or account ID Guid.
329
+ # @param DocuSign_eSign::ListInvoicesOptions Options for modifying the behavior of the function.
330
+ # @return [BillingInvoicesResponse]
331
+ def list_invoices(account_id, options = DocuSign_eSign::ListInvoicesOptions.default)
332
+ data, _status_code, _headers = list_invoices_with_http_info(account_id, options)
333
+ return data
334
+ end
335
+
336
+ # Get a List of Billing Invoices
337
+ # Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator
338
+ # @param account_id The external account number (int) or account ID Guid.
339
+ # @param DocuSign_eSign::ListInvoicesOptions Options for modifying the behavior of the function.
340
+ # @return [Array<(BillingInvoicesResponse, Fixnum, Hash)>] BillingInvoicesResponse data, response status code and response headers
341
+ def list_invoices_with_http_info(account_id, options = DocuSign_eSign::ListInvoicesOptions.default)
342
+ if @api_client.config.debugging
343
+ @api_client.config.logger.debug "Calling API: BillingApi.list_invoices ..."
344
+ end
345
+ # verify the required parameter 'account_id' is set
346
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.list_invoices" if account_id.nil?
347
+ # resource path
348
+ local_var_path = "/v2/accounts/{accountId}/billing_invoices".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
349
+
350
+ # query parameters
351
+ query_params = {}
352
+ query_params[:'from_date'] = options.from_date if !options.from_date.nil?
353
+ query_params[:'to_date'] = options.to_date if !options.to_date.nil?
354
+
355
+ # header parameters
356
+ header_params = {}
357
+ # HTTP header 'Accept' (if needed)
358
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
359
+
360
+ # form parameters
361
+ form_params = {}
362
+
363
+ # http body (model)
364
+ post_body = nil
365
+ auth_names = []
366
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
367
+ :header_params => header_params,
368
+ :query_params => query_params,
369
+ :form_params => form_params,
370
+ :body => post_body,
371
+ :auth_names => auth_names,
372
+ :return_type => 'BillingInvoicesResponse')
373
+ if @api_client.config.debugging
374
+ @api_client.config.logger.debug "API called: BillingApi#list_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
375
+ end
376
+ return data, status_code, headers
377
+ end
378
+
379
+ # Get a list of past due invoices.
380
+ # Returns a list past due invoices for the account and notes if payment can be made through the REST API. Privileges Required: account administrator
381
+ # @param account_id The external account number (int) or account ID Guid.
382
+ # @return [BillingInvoicesSummary]
383
+ def list_invoices_past_due(account_id)
384
+ data, _status_code, _headers = list_invoices_past_due_with_http_info(account_id)
385
+ return data
386
+ end
387
+
388
+ # Get a list of past due invoices.
389
+ # Returns a list past due invoices for the account and notes if payment can be made through the REST API. Privileges Required: account administrator
390
+ # @param account_id The external account number (int) or account ID Guid.
391
+ # @return [Array<(BillingInvoicesSummary, Fixnum, Hash)>] BillingInvoicesSummary data, response status code and response headers
392
+ def list_invoices_past_due_with_http_info(account_id)
393
+ if @api_client.config.debugging
394
+ @api_client.config.logger.debug "Calling API: BillingApi.list_invoices_past_due ..."
395
+ end
396
+ # verify the required parameter 'account_id' is set
397
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.list_invoices_past_due" if account_id.nil?
398
+ # resource path
399
+ local_var_path = "/v2/accounts/{accountId}/billing_invoices_past_due".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
400
+
401
+ # query parameters
402
+ query_params = {}
403
+
404
+ # header parameters
405
+ header_params = {}
406
+ # HTTP header 'Accept' (if needed)
407
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
408
+
409
+ # form parameters
410
+ form_params = {}
411
+
412
+ # http body (model)
413
+ post_body = nil
414
+ auth_names = []
415
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
416
+ :header_params => header_params,
417
+ :query_params => query_params,
418
+ :form_params => form_params,
419
+ :body => post_body,
420
+ :auth_names => auth_names,
421
+ :return_type => 'BillingInvoicesSummary')
422
+ if @api_client.config.debugging
423
+ @api_client.config.logger.debug "API called: BillingApi#list_invoices_past_due\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
424
+ end
425
+ return data, status_code, headers
426
+ end
427
+
428
+ # Gets payment information for one or more payments.
429
+ # Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator
430
+ # @param account_id The external account number (int) or account ID Guid.
431
+ # @param DocuSign_eSign::ListPaymentsOptions Options for modifying the behavior of the function.
432
+ # @return [BillingPaymentsResponse]
433
+ def list_payments(account_id, options = DocuSign_eSign::ListPaymentsOptions.default)
434
+ data, _status_code, _headers = list_payments_with_http_info(account_id, options)
435
+ return data
436
+ end
437
+
438
+ # Gets payment information for one or more payments.
439
+ # Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator
440
+ # @param account_id The external account number (int) or account ID Guid.
441
+ # @param DocuSign_eSign::ListPaymentsOptions Options for modifying the behavior of the function.
442
+ # @return [Array<(BillingPaymentsResponse, Fixnum, Hash)>] BillingPaymentsResponse data, response status code and response headers
443
+ def list_payments_with_http_info(account_id, options = DocuSign_eSign::ListPaymentsOptions.default)
444
+ if @api_client.config.debugging
445
+ @api_client.config.logger.debug "Calling API: BillingApi.list_payments ..."
446
+ end
447
+ # verify the required parameter 'account_id' is set
448
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.list_payments" if account_id.nil?
449
+ # resource path
450
+ local_var_path = "/v2/accounts/{accountId}/billing_payments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
451
+
452
+ # query parameters
453
+ query_params = {}
454
+ query_params[:'from_date'] = options.from_date if !options.from_date.nil?
455
+ query_params[:'to_date'] = options.to_date if !options.to_date.nil?
456
+
457
+ # header parameters
458
+ header_params = {}
459
+ # HTTP header 'Accept' (if needed)
460
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
461
+
462
+ # form parameters
463
+ form_params = {}
464
+
465
+ # http body (model)
466
+ post_body = nil
467
+ auth_names = []
468
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
469
+ :header_params => header_params,
470
+ :query_params => query_params,
471
+ :form_params => form_params,
472
+ :body => post_body,
473
+ :auth_names => auth_names,
474
+ :return_type => 'BillingPaymentsResponse')
475
+ if @api_client.config.debugging
476
+ @api_client.config.logger.debug "API called: BillingApi#list_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
477
+ end
478
+ return data, status_code, headers
479
+ end
480
+
481
+ # Posts a payment to a past due invoice.
482
+ # Posts a payment to a past due invoice. ###### Note: This can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue]. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned. Privileges required: account administrator
483
+ # @param account_id The external account number (int) or account ID Guid.
484
+ # @param billing_payment_request (optional parameter)
485
+ # @return [BillingPaymentResponse]
486
+ def make_payment(account_id, billing_payment_request)
487
+ data, _status_code, _headers = make_payment_with_http_info(account_id, billing_payment_request)
488
+ return data
489
+ end
490
+
491
+ # Posts a payment to a past due invoice.
492
+ # Posts a payment to a past due invoice. ###### Note: This can only be used if the &#x60;paymentAllowed&#x60; value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue]. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the &#x60;nextUri&#x60; and &#x60;previousUri&#x60; properties are not returned. Privileges required: account administrator
493
+ # @param account_id The external account number (int) or account ID Guid.
494
+ # @param billing_payment_request (optional parameter)
495
+ # @return [Array<(BillingPaymentResponse, Fixnum, Hash)>] BillingPaymentResponse data, response status code and response headers
496
+ def make_payment_with_http_info(account_id, billing_payment_request)
497
+ if @api_client.config.debugging
498
+ @api_client.config.logger.debug "Calling API: BillingApi.make_payment ..."
499
+ end
500
+ # verify the required parameter 'account_id' is set
501
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.make_payment" if account_id.nil?
502
+ # resource path
503
+ local_var_path = "/v2/accounts/{accountId}/billing_payments".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
504
+
505
+ # query parameters
506
+ query_params = {}
507
+
508
+ # header parameters
509
+ header_params = {}
510
+ # HTTP header 'Accept' (if needed)
511
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
512
+
513
+ # form parameters
514
+ form_params = {}
515
+
516
+ # http body (model)
517
+ post_body = @api_client.object_to_http_body(billing_payment_request)
518
+ auth_names = []
519
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
520
+ :header_params => header_params,
521
+ :query_params => query_params,
522
+ :form_params => form_params,
523
+ :body => post_body,
524
+ :auth_names => auth_names,
525
+ :return_type => 'BillingPaymentResponse')
526
+ if @api_client.config.debugging
527
+ @api_client.config.logger.debug "API called: BillingApi#make_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
528
+ end
529
+ return data, status_code, headers
530
+ end
531
+
532
+ # Reserverd: Purchase additional envelopes.
533
+ # Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.
534
+ # @param account_id The external account number (int) or account ID Guid.
535
+ # @param purchased_envelopes_information (optional parameter)
536
+ # @return [nil]
537
+ def purchase_envelopes(account_id, purchased_envelopes_information)
538
+ purchase_envelopes_with_http_info(account_id, purchased_envelopes_information)
539
+ return nil
540
+ end
541
+
542
+ # Reserverd: Purchase additional envelopes.
543
+ # Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.
544
+ # @param account_id The external account number (int) or account ID Guid.
545
+ # @param purchased_envelopes_information (optional parameter)
546
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
547
+ def purchase_envelopes_with_http_info(account_id, purchased_envelopes_information)
548
+ if @api_client.config.debugging
549
+ @api_client.config.logger.debug "Calling API: BillingApi.purchase_envelopes ..."
550
+ end
551
+ # verify the required parameter 'account_id' is set
552
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.purchase_envelopes" if account_id.nil?
553
+ # resource path
554
+ local_var_path = "/v2/accounts/{accountId}/billing_plan/purchased_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
555
+
556
+ # query parameters
557
+ query_params = {}
558
+
559
+ # header parameters
560
+ header_params = {}
561
+ # HTTP header 'Accept' (if needed)
562
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
563
+
564
+ # form parameters
565
+ form_params = {}
566
+
567
+ # http body (model)
568
+ post_body = @api_client.object_to_http_body(purchased_envelopes_information)
569
+ auth_names = []
570
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
571
+ :header_params => header_params,
572
+ :query_params => query_params,
573
+ :form_params => form_params,
574
+ :body => post_body,
575
+ :auth_names => auth_names)
576
+ if @api_client.config.debugging
577
+ @api_client.config.logger.debug "API called: BillingApi#purchase_envelopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
578
+ end
579
+ return data, status_code, headers
580
+ end
581
+
582
+ # Updates the account billing plan.
583
+ # Updates the billing plan information, billing address, and credit card information for the specified account.
584
+ # @param account_id The external account number (int) or account ID Guid.
585
+ # @param billing_plan_information (optional parameter)
586
+ # @param DocuSign_eSign::UpdatePlanOptions Options for modifying the behavior of the function.
587
+ # @return [BillingPlanUpdateResponse]
588
+ def update_plan(account_id, billing_plan_information, options = DocuSign_eSign::UpdatePlanOptions.default)
589
+ data, _status_code, _headers = update_plan_with_http_info(account_id, billing_plan_information, options)
590
+ return data
591
+ end
592
+
593
+ # Updates the account billing plan.
594
+ # Updates the billing plan information, billing address, and credit card information for the specified account.
595
+ # @param account_id The external account number (int) or account ID Guid.
596
+ # @param billing_plan_information (optional parameter)
597
+ # @param DocuSign_eSign::UpdatePlanOptions Options for modifying the behavior of the function.
598
+ # @return [Array<(BillingPlanUpdateResponse, Fixnum, Hash)>] BillingPlanUpdateResponse data, response status code and response headers
599
+ def update_plan_with_http_info(account_id, billing_plan_information, options = DocuSign_eSign::UpdatePlanOptions.default)
600
+ if @api_client.config.debugging
601
+ @api_client.config.logger.debug "Calling API: BillingApi.update_plan ..."
602
+ end
603
+ # verify the required parameter 'account_id' is set
604
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.update_plan" if account_id.nil?
605
+ # resource path
606
+ local_var_path = "/v2/accounts/{accountId}/billing_plan".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
607
+
608
+ # query parameters
609
+ query_params = {}
610
+ query_params[:'preview_billing_plan'] = options.preview_billing_plan if !options.preview_billing_plan.nil?
611
+
612
+ # header parameters
613
+ header_params = {}
614
+ # HTTP header 'Accept' (if needed)
615
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
616
+
617
+ # form parameters
618
+ form_params = {}
619
+
620
+ # http body (model)
621
+ post_body = @api_client.object_to_http_body(billing_plan_information)
622
+ auth_names = []
623
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
624
+ :header_params => header_params,
625
+ :query_params => query_params,
626
+ :form_params => form_params,
627
+ :body => post_body,
628
+ :auth_names => auth_names,
629
+ :return_type => 'BillingPlanUpdateResponse')
630
+ if @api_client.config.debugging
631
+ @api_client.config.logger.debug "API called: BillingApi#update_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
632
+ end
633
+ return data, status_code, headers
634
+ end
635
+ end
636
+ end