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,355 @@
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 GetOptions
17
+ # Specifies the number of entries to return.
18
+ attr_accessor :count
19
+
20
+ # Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=”failed,queued”) Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent – This only returns entries with a sent status.
21
+ attr_accessor :include
22
+
23
+ # Specifies the location in the list of envelopes from which to start.
24
+ attr_accessor :start_position
25
+
26
+ def self.default
27
+ @@default ||= GetOptions.new
28
+ end
29
+ end
30
+
31
+ class GetRecipientsOptions
32
+ #
33
+ attr_accessor :include_tabs
34
+
35
+ #
36
+ attr_accessor :start_position
37
+
38
+ def self.default
39
+ @@default ||= GetRecipientsOptions.new
40
+ end
41
+ end
42
+
43
+ class ListOptions
44
+ # The number of results to return. This can be 1 to 20.
45
+ attr_accessor :count
46
+
47
+ #
48
+ attr_accessor :include
49
+
50
+ # The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0.
51
+ attr_accessor :start_position
52
+
53
+ def self.default
54
+ @@default ||= ListOptions.new
55
+ end
56
+ end
57
+
58
+
59
+ class BulkEnvelopesApi
60
+ attr_accessor :api_client
61
+
62
+ def initialize(api_client = BulkEnvelopesApi.default)
63
+ @api_client = api_client
64
+ end
65
+
66
+ # Deletes the bulk recipient file from an envelope.
67
+ # Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.
68
+ # @param account_id The external account number (int) or account ID Guid.
69
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
70
+ # @param recipient_id The ID of the recipient being accessed.
71
+ # @return [BulkRecipientsUpdateResponse]
72
+ def delete_recipients(account_id, envelope_id, recipient_id)
73
+ data, _status_code, _headers = delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
74
+ return data
75
+ end
76
+
77
+ # Deletes the bulk recipient file from an envelope.
78
+ # Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.
79
+ # @param account_id The external account number (int) or account ID Guid.
80
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
81
+ # @param recipient_id The ID of the recipient being accessed.
82
+ # @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
83
+ def delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.delete_recipients ..."
86
+ end
87
+ # verify the required parameter 'account_id' is set
88
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.delete_recipients" if account_id.nil?
89
+ # verify the required parameter 'envelope_id' is set
90
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.delete_recipients" if envelope_id.nil?
91
+ # verify the required parameter 'recipient_id' is set
92
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.delete_recipients" if recipient_id.nil?
93
+ # resource path
94
+ local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
95
+
96
+ # query parameters
97
+ query_params = {}
98
+
99
+ # header parameters
100
+ header_params = {}
101
+ # HTTP header 'Accept' (if needed)
102
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
103
+
104
+ # form parameters
105
+ form_params = {}
106
+
107
+ # http body (model)
108
+ post_body = nil
109
+ auth_names = []
110
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
111
+ :header_params => header_params,
112
+ :query_params => query_params,
113
+ :form_params => form_params,
114
+ :body => post_body,
115
+ :auth_names => auth_names,
116
+ :return_type => 'BulkRecipientsUpdateResponse')
117
+ if @api_client.config.debugging
118
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
119
+ end
120
+ return data, status_code, headers
121
+ end
122
+
123
+ # Gets the status of a specified bulk send operation.
124
+ # Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.
125
+ # @param account_id The external account number (int) or account ID Guid.
126
+ # @param batch_id
127
+ # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
128
+ # @return [BulkEnvelopeStatus]
129
+ def get(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
130
+ data, _status_code, _headers = get_with_http_info(account_id, batch_id, options)
131
+ return data
132
+ end
133
+
134
+ # Gets the status of a specified bulk send operation.
135
+ # Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.
136
+ # @param account_id The external account number (int) or account ID Guid.
137
+ # @param batch_id
138
+ # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
139
+ # @return [Array<(BulkEnvelopeStatus, Fixnum, Hash)>] BulkEnvelopeStatus data, response status code and response headers
140
+ def get_with_http_info(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
141
+ if @api_client.config.debugging
142
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get ..."
143
+ end
144
+ # verify the required parameter 'account_id' is set
145
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get" if account_id.nil?
146
+ # verify the required parameter 'batch_id' is set
147
+ fail ArgumentError, "Missing the required parameter 'batch_id' when calling BulkEnvelopesApi.get" if batch_id.nil?
148
+ # resource path
149
+ local_var_path = "/v2/accounts/{accountId}/bulk_envelopes/{batchId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'batchId' + '}', batch_id.to_s)
150
+
151
+ # query parameters
152
+ query_params = {}
153
+ query_params[:'count'] = options.count if !options.count.nil?
154
+ query_params[:'include'] = options.include if !options.include.nil?
155
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
156
+
157
+ # header parameters
158
+ header_params = {}
159
+ # HTTP header 'Accept' (if needed)
160
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
161
+
162
+ # form parameters
163
+ form_params = {}
164
+
165
+ # http body (model)
166
+ post_body = nil
167
+ auth_names = []
168
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
169
+ :header_params => header_params,
170
+ :query_params => query_params,
171
+ :form_params => form_params,
172
+ :body => post_body,
173
+ :auth_names => auth_names,
174
+ :return_type => 'BulkEnvelopeStatus')
175
+ if @api_client.config.debugging
176
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
177
+ end
178
+ return data, status_code, headers
179
+ end
180
+
181
+ # Gets the bulk recipient file from an envelope.
182
+ # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
183
+ # @param account_id The external account number (int) or account ID Guid.
184
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
185
+ # @param recipient_id The ID of the recipient being accessed.
186
+ # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
187
+ # @return [BulkRecipientsResponse]
188
+ def get_recipients(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
189
+ data, _status_code, _headers = get_recipients_with_http_info(account_id, envelope_id, recipient_id, options)
190
+ return data
191
+ end
192
+
193
+ # Gets the bulk recipient file from an envelope.
194
+ # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
195
+ # @param account_id The external account number (int) or account ID Guid.
196
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
197
+ # @param recipient_id The ID of the recipient being accessed.
198
+ # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
199
+ # @return [Array<(BulkRecipientsResponse, Fixnum, Hash)>] BulkRecipientsResponse data, response status code and response headers
200
+ def get_recipients_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
201
+ if @api_client.config.debugging
202
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_recipients ..."
203
+ end
204
+ # verify the required parameter 'account_id' is set
205
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_recipients" if account_id.nil?
206
+ # verify the required parameter 'envelope_id' is set
207
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.get_recipients" if envelope_id.nil?
208
+ # verify the required parameter 'recipient_id' is set
209
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.get_recipients" if recipient_id.nil?
210
+ # resource path
211
+ local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
212
+
213
+ # query parameters
214
+ query_params = {}
215
+ query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
216
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
217
+
218
+ # header parameters
219
+ header_params = {}
220
+ # HTTP header 'Accept' (if needed)
221
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
222
+
223
+ # form parameters
224
+ form_params = {}
225
+
226
+ # http body (model)
227
+ post_body = nil
228
+ auth_names = []
229
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
230
+ :header_params => header_params,
231
+ :query_params => query_params,
232
+ :form_params => form_params,
233
+ :body => post_body,
234
+ :auth_names => auth_names,
235
+ :return_type => 'BulkRecipientsResponse')
236
+ if @api_client.config.debugging
237
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
238
+ end
239
+ return data, status_code, headers
240
+ end
241
+
242
+ # Gets status information about bulk recipient batches.
243
+ # Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches.
244
+ # @param account_id The external account number (int) or account ID Guid.
245
+ # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
246
+ # @return [BulkEnvelopesResponse]
247
+ def list(account_id, options = DocuSign_eSign::ListOptions.default)
248
+ data, _status_code, _headers = list_with_http_info(account_id, options)
249
+ return data
250
+ end
251
+
252
+ # Gets status information about bulk recipient batches.
253
+ # Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the &#x60;batchId&#x60; property, which can be used to retrieve a more detailed status of individual bulk recipient batches.
254
+ # @param account_id The external account number (int) or account ID Guid.
255
+ # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
256
+ # @return [Array<(BulkEnvelopesResponse, Fixnum, Hash)>] BulkEnvelopesResponse data, response status code and response headers
257
+ def list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default)
258
+ if @api_client.config.debugging
259
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.list ..."
260
+ end
261
+ # verify the required parameter 'account_id' is set
262
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.list" if account_id.nil?
263
+ # resource path
264
+ local_var_path = "/v2/accounts/{accountId}/bulk_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
265
+
266
+ # query parameters
267
+ query_params = {}
268
+ query_params[:'count'] = options.count if !options.count.nil?
269
+ query_params[:'include'] = options.include if !options.include.nil?
270
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
271
+
272
+ # header parameters
273
+ header_params = {}
274
+ # HTTP header 'Accept' (if needed)
275
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
276
+
277
+ # form parameters
278
+ form_params = {}
279
+
280
+ # http body (model)
281
+ post_body = nil
282
+ auth_names = []
283
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
284
+ :header_params => header_params,
285
+ :query_params => query_params,
286
+ :form_params => form_params,
287
+ :body => post_body,
288
+ :auth_names => auth_names,
289
+ :return_type => 'BulkEnvelopesResponse')
290
+ if @api_client.config.debugging
291
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
292
+ end
293
+ return data, status_code, headers
294
+ end
295
+
296
+ # Adds or replaces envelope bulk recipients.
297
+ # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
298
+ # @param account_id The external account number (int) or account ID Guid.
299
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
300
+ # @param recipient_id The ID of the recipient being accessed.
301
+ # @param bulk_recipients_request (optional parameter)
302
+ # @return [BulkRecipientsSummaryResponse]
303
+ def update_recipients(account_id, envelope_id, recipient_id, bulk_recipients_request)
304
+ data, _status_code, _headers = update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
305
+ return data
306
+ end
307
+
308
+ # Adds or replaces envelope bulk recipients.
309
+ # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
310
+ # @param account_id The external account number (int) or account ID Guid.
311
+ # @param envelope_id The envelopeId Guid of the envelope being accessed.
312
+ # @param recipient_id The ID of the recipient being accessed.
313
+ # @param bulk_recipients_request (optional parameter)
314
+ # @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
315
+ def update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
316
+ if @api_client.config.debugging
317
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_recipients ..."
318
+ end
319
+ # verify the required parameter 'account_id' is set
320
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_recipients" if account_id.nil?
321
+ # verify the required parameter 'envelope_id' is set
322
+ fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.update_recipients" if envelope_id.nil?
323
+ # verify the required parameter 'recipient_id' is set
324
+ fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.update_recipients" if recipient_id.nil?
325
+ # resource path
326
+ local_var_path = "/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
327
+
328
+ # query parameters
329
+ query_params = {}
330
+
331
+ # header parameters
332
+ header_params = {}
333
+ # HTTP header 'Accept' (if needed)
334
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
335
+
336
+ # form parameters
337
+ form_params = {}
338
+
339
+ # http body (model)
340
+ post_body = @api_client.object_to_http_body(bulk_recipients_request)
341
+ auth_names = []
342
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
343
+ :header_params => header_params,
344
+ :query_params => query_params,
345
+ :form_params => form_params,
346
+ :body => post_body,
347
+ :auth_names => auth_names,
348
+ :return_type => 'BulkRecipientsSummaryResponse')
349
+ if @api_client.config.debugging
350
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
351
+ end
352
+ return data, status_code, headers
353
+ end
354
+ end
355
+ end
@@ -0,0 +1,507 @@
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 GetProviderOptions
17
+ # The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.
18
+ attr_accessor :redirect_url
19
+
20
+ def self.default
21
+ @@default ||= GetProviderOptions.new
22
+ end
23
+ end
24
+
25
+ class ListOptions
26
+ #
27
+ attr_accessor :cloud_storage_folder_path
28
+
29
+ # An optional value that sets how many items are included in the response. The default setting for this is 25.
30
+ attr_accessor :count
31
+
32
+ # An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order
33
+ attr_accessor :order
34
+
35
+ # An optional value that sets the file attribute used to sort the item list. Valid values are: * modified * name
36
+ attr_accessor :order_by
37
+
38
+ #
39
+ attr_accessor :search_text
40
+
41
+ # Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.
42
+ attr_accessor :start_position
43
+
44
+ def self.default
45
+ @@default ||= ListOptions.new
46
+ end
47
+ end
48
+
49
+ class ListFoldersOptions
50
+ # A comma separated list of folder IDs included in the request.
51
+ attr_accessor :cloud_storage_folder_path
52
+
53
+ # An optional value that sets how many items are included in the response. The default setting for this is 25.
54
+ attr_accessor :count
55
+
56
+ # An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order
57
+ attr_accessor :order
58
+
59
+ # An optional value that sets the file attribute used to sort the item list. Valid values are: * modified * name
60
+ attr_accessor :order_by
61
+
62
+ #
63
+ attr_accessor :search_text
64
+
65
+ # Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.
66
+ attr_accessor :start_position
67
+
68
+ def self.default
69
+ @@default ||= ListFoldersOptions.new
70
+ end
71
+ end
72
+
73
+ class ListProvidersOptions
74
+ # The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.
75
+ attr_accessor :redirect_url
76
+
77
+ def self.default
78
+ @@default ||= ListProvidersOptions.new
79
+ end
80
+ end
81
+
82
+
83
+ class CloudStorageApi
84
+ attr_accessor :api_client
85
+
86
+ def initialize(api_client = CloudStorageApi.default)
87
+ @api_client = api_client
88
+ end
89
+
90
+ # Configures the redirect URL information for one or more cloud storage providers for the specified user.
91
+ # Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.
92
+ # @param account_id The external account number (int) or account ID Guid.
93
+ # @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.
94
+ # @param cloud_storage_providers (optional parameter)
95
+ # @return [CloudStorageProviders]
96
+ def create_provider(account_id, user_id, cloud_storage_providers)
97
+ data, _status_code, _headers = create_provider_with_http_info(account_id, user_id, cloud_storage_providers)
98
+ return data
99
+ end
100
+
101
+ # Configures the redirect URL information for one or more cloud storage providers for the specified user.
102
+ # Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.
103
+ # @param account_id The external account number (int) or account ID Guid.
104
+ # @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.
105
+ # @param cloud_storage_providers (optional parameter)
106
+ # @return [Array<(CloudStorageProviders, Fixnum, Hash)>] CloudStorageProviders data, response status code and response headers
107
+ def create_provider_with_http_info(account_id, user_id, cloud_storage_providers)
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug "Calling API: CloudStorageApi.create_provider ..."
110
+ end
111
+ # verify the required parameter 'account_id' is set
112
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.create_provider" if account_id.nil?
113
+ # verify the required parameter 'user_id' is set
114
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.create_provider" if user_id.nil?
115
+ # resource path
116
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/cloud_storage".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
117
+
118
+ # query parameters
119
+ query_params = {}
120
+
121
+ # header parameters
122
+ header_params = {}
123
+ # HTTP header 'Accept' (if needed)
124
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
125
+
126
+ # form parameters
127
+ form_params = {}
128
+
129
+ # http body (model)
130
+ post_body = @api_client.object_to_http_body(cloud_storage_providers)
131
+ auth_names = []
132
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => 'CloudStorageProviders')
139
+ if @api_client.config.debugging
140
+ @api_client.config.logger.debug "API called: CloudStorageApi#create_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
141
+ end
142
+ return data, status_code, headers
143
+ end
144
+
145
+ # Deletes the user authentication information for the specified cloud storage provider.
146
+ # Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.
147
+ # @param account_id The external account number (int) or account ID Guid.
148
+ # @param service_id The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").
149
+ # @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.
150
+ # @return [CloudStorageProviders]
151
+ def delete_provider(account_id, service_id, user_id)
152
+ data, _status_code, _headers = delete_provider_with_http_info(account_id, service_id, user_id)
153
+ return data
154
+ end
155
+
156
+ # Deletes the user authentication information for the specified cloud storage provider.
157
+ # Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.
158
+ # @param account_id The external account number (int) or account ID Guid.
159
+ # @param service_id The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").
160
+ # @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.
161
+ # @return [Array<(CloudStorageProviders, Fixnum, Hash)>] CloudStorageProviders data, response status code and response headers
162
+ def delete_provider_with_http_info(account_id, service_id, user_id)
163
+ if @api_client.config.debugging
164
+ @api_client.config.logger.debug "Calling API: CloudStorageApi.delete_provider ..."
165
+ end
166
+ # verify the required parameter 'account_id' is set
167
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.delete_provider" if account_id.nil?
168
+ # verify the required parameter 'service_id' is set
169
+ fail ArgumentError, "Missing the required parameter 'service_id' when calling CloudStorageApi.delete_provider" if service_id.nil?
170
+ # verify the required parameter 'user_id' is set
171
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.delete_provider" if user_id.nil?
172
+ # resource path
173
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'serviceId' + '}', service_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
174
+
175
+ # query parameters
176
+ query_params = {}
177
+
178
+ # header parameters
179
+ header_params = {}
180
+ # HTTP header 'Accept' (if needed)
181
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
182
+
183
+ # form parameters
184
+ form_params = {}
185
+
186
+ # http body (model)
187
+ post_body = nil
188
+ auth_names = []
189
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
190
+ :header_params => header_params,
191
+ :query_params => query_params,
192
+ :form_params => form_params,
193
+ :body => post_body,
194
+ :auth_names => auth_names,
195
+ :return_type => 'CloudStorageProviders')
196
+ if @api_client.config.debugging
197
+ @api_client.config.logger.debug "API called: CloudStorageApi#delete_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
198
+ end
199
+ return data, status_code, headers
200
+ end
201
+
202
+ # Deletes the user authentication information for one or more cloud storage providers.
203
+ # Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.
204
+ # @param account_id The external account number (int) or account ID Guid.
205
+ # @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.
206
+ # @param cloud_storage_providers (optional parameter)
207
+ # @return [CloudStorageProviders]
208
+ def delete_providers(account_id, user_id, cloud_storage_providers)
209
+ data, _status_code, _headers = delete_providers_with_http_info(account_id, user_id, cloud_storage_providers)
210
+ return data
211
+ end
212
+
213
+ # Deletes the user authentication information for one or more cloud storage providers.
214
+ # Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.
215
+ # @param account_id The external account number (int) or account ID Guid.
216
+ # @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.
217
+ # @param cloud_storage_providers (optional parameter)
218
+ # @return [Array<(CloudStorageProviders, Fixnum, Hash)>] CloudStorageProviders data, response status code and response headers
219
+ def delete_providers_with_http_info(account_id, user_id, cloud_storage_providers)
220
+ if @api_client.config.debugging
221
+ @api_client.config.logger.debug "Calling API: CloudStorageApi.delete_providers ..."
222
+ end
223
+ # verify the required parameter 'account_id' is set
224
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.delete_providers" if account_id.nil?
225
+ # verify the required parameter 'user_id' is set
226
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.delete_providers" if user_id.nil?
227
+ # resource path
228
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/cloud_storage".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
229
+
230
+ # query parameters
231
+ query_params = {}
232
+
233
+ # header parameters
234
+ header_params = {}
235
+ # HTTP header 'Accept' (if needed)
236
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
237
+
238
+ # form parameters
239
+ form_params = {}
240
+
241
+ # http body (model)
242
+ post_body = @api_client.object_to_http_body(cloud_storage_providers)
243
+ auth_names = []
244
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
245
+ :header_params => header_params,
246
+ :query_params => query_params,
247
+ :form_params => form_params,
248
+ :body => post_body,
249
+ :auth_names => auth_names,
250
+ :return_type => 'CloudStorageProviders')
251
+ if @api_client.config.debugging
252
+ @api_client.config.logger.debug "API called: CloudStorageApi#delete_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
253
+ end
254
+ return data, status_code, headers
255
+ end
256
+
257
+ # Gets the specified Cloud Storage Provider configuration for the User.
258
+ # Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.
259
+ # @param account_id The external account number (int) or account ID Guid.
260
+ # @param service_id The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").
261
+ # @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.
262
+ # @param DocuSign_eSign::GetProviderOptions Options for modifying the behavior of the function.
263
+ # @return [CloudStorageProviders]
264
+ def get_provider(account_id, service_id, user_id, options = DocuSign_eSign::GetProviderOptions.default)
265
+ data, _status_code, _headers = get_provider_with_http_info(account_id, service_id, user_id, options)
266
+ return data
267
+ end
268
+
269
+ # Gets the specified Cloud Storage Provider configuration for the User.
270
+ # Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.
271
+ # @param account_id The external account number (int) or account ID Guid.
272
+ # @param service_id The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").
273
+ # @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.
274
+ # @param DocuSign_eSign::GetProviderOptions Options for modifying the behavior of the function.
275
+ # @return [Array<(CloudStorageProviders, Fixnum, Hash)>] CloudStorageProviders data, response status code and response headers
276
+ def get_provider_with_http_info(account_id, service_id, user_id, options = DocuSign_eSign::GetProviderOptions.default)
277
+ if @api_client.config.debugging
278
+ @api_client.config.logger.debug "Calling API: CloudStorageApi.get_provider ..."
279
+ end
280
+ # verify the required parameter 'account_id' is set
281
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.get_provider" if account_id.nil?
282
+ # verify the required parameter 'service_id' is set
283
+ fail ArgumentError, "Missing the required parameter 'service_id' when calling CloudStorageApi.get_provider" if service_id.nil?
284
+ # verify the required parameter 'user_id' is set
285
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.get_provider" if user_id.nil?
286
+ # resource path
287
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'serviceId' + '}', service_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
288
+
289
+ # query parameters
290
+ query_params = {}
291
+ query_params[:'redirectUrl'] = options.redirect_url if !options.redirect_url.nil?
292
+
293
+ # header parameters
294
+ header_params = {}
295
+ # HTTP header 'Accept' (if needed)
296
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
297
+
298
+ # form parameters
299
+ form_params = {}
300
+
301
+ # http body (model)
302
+ post_body = nil
303
+ auth_names = []
304
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
305
+ :header_params => header_params,
306
+ :query_params => query_params,
307
+ :form_params => form_params,
308
+ :body => post_body,
309
+ :auth_names => auth_names,
310
+ :return_type => 'CloudStorageProviders')
311
+ if @api_client.config.debugging
312
+ @api_client.config.logger.debug "API called: CloudStorageApi#get_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
313
+ end
314
+ return data, status_code, headers
315
+ end
316
+
317
+ # Gets a list of all the items from the specified cloud storage provider.
318
+ # Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.
319
+ # @param account_id The external account number (int) or account ID Guid.
320
+ # @param folder_id The ID of the folder being accessed.
321
+ # @param service_id The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").
322
+ # @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.
323
+ # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
324
+ # @return [ExternalFolder]
325
+ def list(account_id, folder_id, service_id, user_id, options = DocuSign_eSign::ListOptions.default)
326
+ data, _status_code, _headers = list_with_http_info(account_id, folder_id, service_id, user_id, options)
327
+ return data
328
+ end
329
+
330
+ # Gets a list of all the items from the specified cloud storage provider.
331
+ # Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.
332
+ # @param account_id The external account number (int) or account ID Guid.
333
+ # @param folder_id The ID of the folder being accessed.
334
+ # @param service_id The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").
335
+ # @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.
336
+ # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
337
+ # @return [Array<(ExternalFolder, Fixnum, Hash)>] ExternalFolder data, response status code and response headers
338
+ def list_with_http_info(account_id, folder_id, service_id, user_id, options = DocuSign_eSign::ListOptions.default)
339
+ if @api_client.config.debugging
340
+ @api_client.config.logger.debug "Calling API: CloudStorageApi.list ..."
341
+ end
342
+ # verify the required parameter 'account_id' is set
343
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.list" if account_id.nil?
344
+ # verify the required parameter 'folder_id' is set
345
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling CloudStorageApi.list" if folder_id.nil?
346
+ # verify the required parameter 'service_id' is set
347
+ fail ArgumentError, "Missing the required parameter 'service_id' when calling CloudStorageApi.list" if service_id.nil?
348
+ # verify the required parameter 'user_id' is set
349
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.list" if user_id.nil?
350
+ # resource path
351
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'serviceId' + '}', service_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
352
+
353
+ # query parameters
354
+ query_params = {}
355
+ query_params[:'cloud_storage_folder_path'] = options.cloud_storage_folder_path if !options.cloud_storage_folder_path.nil?
356
+ query_params[:'count'] = options.count if !options.count.nil?
357
+ query_params[:'order'] = options.order if !options.order.nil?
358
+ query_params[:'order_by'] = options.order_by if !options.order_by.nil?
359
+ query_params[:'search_text'] = options.search_text if !options.search_text.nil?
360
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
361
+
362
+ # header parameters
363
+ header_params = {}
364
+ # HTTP header 'Accept' (if needed)
365
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
366
+
367
+ # form parameters
368
+ form_params = {}
369
+
370
+ # http body (model)
371
+ post_body = nil
372
+ auth_names = []
373
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
374
+ :header_params => header_params,
375
+ :query_params => query_params,
376
+ :form_params => form_params,
377
+ :body => post_body,
378
+ :auth_names => auth_names,
379
+ :return_type => 'ExternalFolder')
380
+ if @api_client.config.debugging
381
+ @api_client.config.logger.debug "API called: CloudStorageApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
382
+ end
383
+ return data, status_code, headers
384
+ end
385
+
386
+ # Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
387
+ # Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
388
+ # @param account_id The external account number (int) or account ID Guid.
389
+ # @param service_id The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").
390
+ # @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.
391
+ # @param DocuSign_eSign::ListFoldersOptions Options for modifying the behavior of the function.
392
+ # @return [ExternalFolder]
393
+ def list_folders(account_id, service_id, user_id, options = DocuSign_eSign::ListFoldersOptions.default)
394
+ data, _status_code, _headers = list_folders_with_http_info(account_id, service_id, user_id, options)
395
+ return data
396
+ end
397
+
398
+ # Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
399
+ # Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
400
+ # @param account_id The external account number (int) or account ID Guid.
401
+ # @param service_id The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").
402
+ # @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.
403
+ # @param DocuSign_eSign::ListFoldersOptions Options for modifying the behavior of the function.
404
+ # @return [Array<(ExternalFolder, Fixnum, Hash)>] ExternalFolder data, response status code and response headers
405
+ def list_folders_with_http_info(account_id, service_id, user_id, options = DocuSign_eSign::ListFoldersOptions.default)
406
+ if @api_client.config.debugging
407
+ @api_client.config.logger.debug "Calling API: CloudStorageApi.list_folders ..."
408
+ end
409
+ # verify the required parameter 'account_id' is set
410
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.list_folders" if account_id.nil?
411
+ # verify the required parameter 'service_id' is set
412
+ fail ArgumentError, "Missing the required parameter 'service_id' when calling CloudStorageApi.list_folders" if service_id.nil?
413
+ # verify the required parameter 'user_id' is set
414
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.list_folders" if user_id.nil?
415
+ # resource path
416
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'serviceId' + '}', service_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
417
+
418
+ # query parameters
419
+ query_params = {}
420
+ query_params[:'cloud_storage_folder_path'] = options.cloud_storage_folder_path if !options.cloud_storage_folder_path.nil?
421
+ query_params[:'count'] = options.count if !options.count.nil?
422
+ query_params[:'order'] = options.order if !options.order.nil?
423
+ query_params[:'order_by'] = options.order_by if !options.order_by.nil?
424
+ query_params[:'search_text'] = options.search_text if !options.search_text.nil?
425
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
426
+
427
+ # header parameters
428
+ header_params = {}
429
+ # HTTP header 'Accept' (if needed)
430
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
431
+
432
+ # form parameters
433
+ form_params = {}
434
+
435
+ # http body (model)
436
+ post_body = nil
437
+ auth_names = []
438
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
439
+ :header_params => header_params,
440
+ :query_params => query_params,
441
+ :form_params => form_params,
442
+ :body => post_body,
443
+ :auth_names => auth_names,
444
+ :return_type => 'ExternalFolder')
445
+ if @api_client.config.debugging
446
+ @api_client.config.logger.debug "API called: CloudStorageApi#list_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
447
+ end
448
+ return data, status_code, headers
449
+ end
450
+
451
+ # Get the Cloud Storage Provider configuration for the specified user.
452
+ # Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. The {serviceId} parameter can be either the service name or serviceId.
453
+ # @param account_id The external account number (int) or account ID Guid.
454
+ # @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.
455
+ # @param DocuSign_eSign::ListProvidersOptions Options for modifying the behavior of the function.
456
+ # @return [CloudStorageProviders]
457
+ def list_providers(account_id, user_id, options = DocuSign_eSign::ListProvidersOptions.default)
458
+ data, _status_code, _headers = list_providers_with_http_info(account_id, user_id, options)
459
+ return data
460
+ end
461
+
462
+ # Get the Cloud Storage Provider configuration for the specified user.
463
+ # Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. The {serviceId} parameter can be either the service name or serviceId.
464
+ # @param account_id The external account number (int) or account ID Guid.
465
+ # @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.
466
+ # @param DocuSign_eSign::ListProvidersOptions Options for modifying the behavior of the function.
467
+ # @return [Array<(CloudStorageProviders, Fixnum, Hash)>] CloudStorageProviders data, response status code and response headers
468
+ def list_providers_with_http_info(account_id, user_id, options = DocuSign_eSign::ListProvidersOptions.default)
469
+ if @api_client.config.debugging
470
+ @api_client.config.logger.debug "Calling API: CloudStorageApi.list_providers ..."
471
+ end
472
+ # verify the required parameter 'account_id' is set
473
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudStorageApi.list_providers" if account_id.nil?
474
+ # verify the required parameter 'user_id' is set
475
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling CloudStorageApi.list_providers" if user_id.nil?
476
+ # resource path
477
+ local_var_path = "/v2/accounts/{accountId}/users/{userId}/cloud_storage".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
478
+
479
+ # query parameters
480
+ query_params = {}
481
+ query_params[:'redirectUrl'] = options.redirect_url if !options.redirect_url.nil?
482
+
483
+ # header parameters
484
+ header_params = {}
485
+ # HTTP header 'Accept' (if needed)
486
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
487
+
488
+ # form parameters
489
+ form_params = {}
490
+
491
+ # http body (model)
492
+ post_body = nil
493
+ auth_names = []
494
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
495
+ :header_params => header_params,
496
+ :query_params => query_params,
497
+ :form_params => form_params,
498
+ :body => post_body,
499
+ :auth_names => auth_names,
500
+ :return_type => 'CloudStorageProviders')
501
+ if @api_client.config.debugging
502
+ @api_client.config.logger.debug "API called: CloudStorageApi#list_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
503
+ end
504
+ return data, status_code, headers
505
+ end
506
+ end
507
+ end