docusign_esign 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE +21 -0
- data/README.md +101 -0
- data/Rakefile +8 -0
- data/docs/AccountAddress.md +19 -0
- data/docs/AccountBillingPlan.md +27 -0
- data/docs/AccountBillingPlanResponse.md +13 -0
- data/docs/AccountInformation.md +38 -0
- data/docs/AccountRoleSettings.md +71 -0
- data/docs/AccountSettingsInformation.md +8 -0
- data/docs/AccountSharedAccess.md +16 -0
- data/docs/AccountSignatureProvider.md +14 -0
- data/docs/AccountSignatureProviderOption.md +10 -0
- data/docs/AccountSignatureProviders.md +8 -0
- data/docs/AccountsApi.md +1997 -0
- data/docs/AddOn.md +11 -0
- data/docs/AddressInformation.md +15 -0
- data/docs/AddressInformationInput.md +10 -0
- data/docs/AddressInformationV2.md +15 -0
- data/docs/Agent.md +49 -0
- data/docs/ApiRequestLog.md +11 -0
- data/docs/ApiRequestLogsResult.md +8 -0
- data/docs/AppStoreProduct.md +9 -0
- data/docs/AppStoreReceipt.md +9 -0
- data/docs/Approve.md +40 -0
- data/docs/Attachment.md +14 -0
- data/docs/AuthenticationApi.md +356 -0
- data/docs/AuthenticationMethod.md +11 -0
- data/docs/AuthenticationStatus.md +24 -0
- data/docs/BccEmailAddress.md +9 -0
- data/docs/BillingApi.md +569 -0
- data/docs/BillingCharge.md +20 -0
- data/docs/BillingChargeResponse.md +8 -0
- data/docs/BillingDiscount.md +10 -0
- data/docs/BillingInvoice.md +17 -0
- data/docs/BillingInvoiceItem.md +12 -0
- data/docs/BillingInvoicesResponse.md +10 -0
- data/docs/BillingInvoicesSummary.md +10 -0
- data/docs/BillingPayment.md +10 -0
- data/docs/BillingPaymentItem.md +12 -0
- data/docs/BillingPaymentRequest.md +8 -0
- data/docs/BillingPaymentResponse.md +8 -0
- data/docs/BillingPaymentsResponse.md +10 -0
- data/docs/BillingPlan.md +22 -0
- data/docs/BillingPlanInformation.md +22 -0
- data/docs/BillingPlanPreview.md +13 -0
- data/docs/BillingPlanResponse.md +9 -0
- data/docs/BillingPlanUpdateResponse.md +14 -0
- data/docs/BillingPlansResponse.md +8 -0
- data/docs/BillingPrice.md +10 -0
- data/docs/Brand.md +20 -0
- data/docs/BrandEmailContent.md +11 -0
- data/docs/BrandLink.md +11 -0
- data/docs/BrandLogos.md +10 -0
- data/docs/BrandRequest.md +8 -0
- data/docs/BrandResourceUrls.md +11 -0
- data/docs/BrandResources.md +14 -0
- data/docs/BrandResourcesList.md +8 -0
- data/docs/BrandsRequest.md +8 -0
- data/docs/BrandsResponse.md +10 -0
- data/docs/BulkEnvelope.md +16 -0
- data/docs/BulkEnvelopeStatus.md +21 -0
- data/docs/BulkEnvelopesApi.md +295 -0
- data/docs/BulkEnvelopesResponse.md +14 -0
- data/docs/BulkRecipient.md +17 -0
- data/docs/BulkRecipientSignatureProvider.md +9 -0
- data/docs/BulkRecipientTabLabel.md +9 -0
- data/docs/BulkRecipientsRequest.md +8 -0
- data/docs/BulkRecipientsResponse.md +14 -0
- data/docs/BulkRecipientsSummaryResponse.md +11 -0
- data/docs/BulkRecipientsUpdateResponse.md +8 -0
- data/docs/CaptiveRecipient.md +11 -0
- data/docs/CaptiveRecipientInformation.md +8 -0
- data/docs/CarbonCopy.md +49 -0
- data/docs/CertifiedDelivery.md +49 -0
- data/docs/Checkbox.md +37 -0
- data/docs/ChunkedUploadPart.md +9 -0
- data/docs/ChunkedUploadRequest.md +9 -0
- data/docs/ChunkedUploadResponse.md +14 -0
- data/docs/CloudStorageApi.md +424 -0
- data/docs/CloudStorageProvider.md +12 -0
- data/docs/CloudStorageProviders.md +8 -0
- data/docs/Company.md +46 -0
- data/docs/CompositeTemplate.md +12 -0
- data/docs/ConnectApi.md +891 -0
- data/docs/ConnectConfigResults.md +9 -0
- data/docs/ConnectCustomConfiguration.md +28 -0
- data/docs/ConnectDebugLog.md +12 -0
- data/docs/ConnectFailureFilter.md +9 -0
- data/docs/ConnectFailureResult.md +12 -0
- data/docs/ConnectFailureResults.md +8 -0
- data/docs/ConnectLog.md +25 -0
- data/docs/ConnectLogs.md +11 -0
- data/docs/ConsoleViewRequest.md +9 -0
- data/docs/ConsumerDisclosure.md +37 -0
- data/docs/Contact.md +16 -0
- data/docs/ContactGetResponse.md +14 -0
- data/docs/ContactModRequest.md +8 -0
- data/docs/ContactUpdateResponse.md +8 -0
- data/docs/CorrectViewRequest.md +9 -0
- data/docs/Country.md +11 -0
- data/docs/CreditCardInformation.md +13 -0
- data/docs/CreditCardTypes.md +8 -0
- data/docs/CurrencyFeatureSetPrice.md +12 -0
- data/docs/CurrencyPlanPrice.md +13 -0
- data/docs/CustomFieldV2.md +14 -0
- data/docs/CustomFields.md +9 -0
- data/docs/CustomFieldsEnvelope.md +9 -0
- data/docs/CustomSettingsInformation.md +8 -0
- data/docs/CustomTabsApi.md +268 -0
- data/docs/Date.md +52 -0
- data/docs/DateSigned.md +39 -0
- data/docs/Decline.md +41 -0
- data/docs/DiagnosticsApi.md +321 -0
- data/docs/DiagnosticsSettingsInformation.md +10 -0
- data/docs/DobInformationInput.md +10 -0
- data/docs/Document.md +27 -0
- data/docs/DocumentFieldsInformation.md +8 -0
- data/docs/DocumentTemplate.md +12 -0
- data/docs/DocumentTemplateList.md +8 -0
- data/docs/DocumentVisibility.md +12 -0
- data/docs/DocumentVisibilityList.md +8 -0
- data/docs/ENoteConfiguration.md +12 -0
- data/docs/Editor.md +48 -0
- data/docs/Email.md +52 -0
- data/docs/EmailAddress.md +38 -0
- data/docs/EmailSettings.md +10 -0
- data/docs/Envelope.md +54 -0
- data/docs/EnvelopeAttachment.md +13 -0
- data/docs/EnvelopeAttachmentsRequest.md +8 -0
- data/docs/EnvelopeAttachmentsResult.md +8 -0
- data/docs/EnvelopeAuditEvent.md +8 -0
- data/docs/EnvelopeAuditEventResponse.md +8 -0
- data/docs/EnvelopeDefinition.md +63 -0
- data/docs/EnvelopeDocument.md +24 -0
- data/docs/EnvelopeDocumentsResult.md +9 -0
- data/docs/EnvelopeEvent.md +9 -0
- data/docs/EnvelopeFormData.md +13 -0
- data/docs/EnvelopeId.md +38 -0
- data/docs/EnvelopeIdsRequest.md +9 -0
- data/docs/EnvelopeNotificationRequest.md +10 -0
- data/docs/EnvelopeSummary.md +11 -0
- data/docs/EnvelopeTemplate.md +56 -0
- data/docs/EnvelopeTemplateDefinition.md +22 -0
- data/docs/EnvelopeTemplateResult.md +68 -0
- data/docs/EnvelopeTemplateResults.md +15 -0
- data/docs/EnvelopeTransactionStatus.md +11 -0
- data/docs/EnvelopeUpdateSummary.md +15 -0
- data/docs/EnvelopesApi.md +4306 -0
- data/docs/EnvelopesInformation.md +15 -0
- data/docs/ErrorDetails.md +9 -0
- data/docs/EventNotification.md +22 -0
- data/docs/EventResult.md +11 -0
- data/docs/Expirations.md +10 -0
- data/docs/ExternalDocServiceErrorDetails.md +10 -0
- data/docs/ExternalFile.md +15 -0
- data/docs/ExternalFolder.md +17 -0
- data/docs/FeatureSet.md +16 -0
- data/docs/FileType.md +9 -0
- data/docs/FileTypeList.md +8 -0
- data/docs/Filter.md +18 -0
- data/docs/FirstName.md +38 -0
- data/docs/Folder.md +19 -0
- data/docs/FolderItem.md +28 -0
- data/docs/FolderItemResponse.md +14 -0
- data/docs/FolderItemV2.md +27 -0
- data/docs/FolderItemsResponse.md +14 -0
- data/docs/FoldersApi.md +261 -0
- data/docs/FoldersRequest.md +9 -0
- data/docs/FoldersResponse.md +8 -0
- data/docs/ForgottenPasswordInformation.md +15 -0
- data/docs/FormulaTab.md +56 -0
- data/docs/FullName.md +38 -0
- data/docs/Group.md +13 -0
- data/docs/GroupInformation.md +14 -0
- data/docs/GroupsApi.md +552 -0
- data/docs/IdCheckInformationInput.md +11 -0
- data/docs/InPersonSigner.md +62 -0
- data/docs/InitialHere.md +34 -0
- data/docs/InlineTemplate.md +12 -0
- data/docs/IntegratedUserInfoList.md +15 -0
- data/docs/Intermediary.md +49 -0
- data/docs/LastName.md +38 -0
- data/docs/List.md +46 -0
- data/docs/ListCustomField.md +15 -0
- data/docs/ListItem.md +10 -0
- data/docs/LockInformation.md +15 -0
- data/docs/LockRequest.md +12 -0
- data/docs/LoginAccount.md +18 -0
- data/docs/LoginInformation.md +9 -0
- data/docs/MatchBox.md +12 -0
- data/docs/MemberGroupSharedItem.md +10 -0
- data/docs/MemberSharedItems.md +11 -0
- data/docs/MergeField.md +12 -0
- data/docs/MobileNotifierConfiguration.md +10 -0
- data/docs/MobileNotifierConfigurationInformation.md +8 -0
- data/docs/Money.md +10 -0
- data/docs/NameValue.md +11 -0
- data/docs/NewAccountDefinition.md +17 -0
- data/docs/NewAccountSummary.md +14 -0
- data/docs/NewUser.md +17 -0
- data/docs/NewUsersDefinition.md +8 -0
- data/docs/NewUsersSummary.md +8 -0
- data/docs/NotaryHost.md +47 -0
- data/docs/Note.md +42 -0
- data/docs/Notification.md +10 -0
- data/docs/Number.md +54 -0
- data/docs/OauthAccess.md +13 -0
- data/docs/OfflineAttributes.md +13 -0
- data/docs/Page.md +15 -0
- data/docs/PageImages.md +14 -0
- data/docs/PageRequest.md +9 -0
- data/docs/PaymentDetails.md +12 -0
- data/docs/PaymentLineItem.md +11 -0
- data/docs/PermissionProfile.md +14 -0
- data/docs/PermissionProfileInformation.md +8 -0
- data/docs/PlanInformation.md +13 -0
- data/docs/PostTransactionsRequest.md +11 -0
- data/docs/PostTransactionsResponse.md +9 -0
- data/docs/PowerForm.md +31 -0
- data/docs/PowerFormFormDataEnvelope.md +9 -0
- data/docs/PowerFormFormDataRecipient.md +11 -0
- data/docs/PowerFormRecipient.md +20 -0
- data/docs/PowerFormSendersResponse.md +14 -0
- data/docs/PowerFormsApi.md +419 -0
- data/docs/PowerFormsFormDataResponse.md +8 -0
- data/docs/PowerFormsRequest.md +8 -0
- data/docs/PowerFormsResponse.md +14 -0
- data/docs/PropertyMetadata.md +9 -0
- data/docs/Province.md +9 -0
- data/docs/ProvisioningInformation.md +14 -0
- data/docs/PurchasedEnvelopesInformation.md +16 -0
- data/docs/Radio.md +25 -0
- data/docs/RadioGroup.md +16 -0
- data/docs/RecipientAttachment.md +13 -0
- data/docs/RecipientDomain.md +11 -0
- data/docs/RecipientEmailNotification.md +10 -0
- data/docs/RecipientEvent.md +9 -0
- data/docs/RecipientFormData.md +15 -0
- data/docs/RecipientNamesResponse.md +10 -0
- data/docs/RecipientPhoneAuthentication.md +11 -0
- data/docs/RecipientSAMLAuthentication.md +8 -0
- data/docs/RecipientSMSAuthentication.md +8 -0
- data/docs/RecipientSignatureInformation.md +10 -0
- data/docs/RecipientSignatureProvider.md +9 -0
- data/docs/RecipientSignatureProviderOptions.md +11 -0
- data/docs/RecipientUpdateResponse.md +10 -0
- data/docs/RecipientViewRequest.md +21 -0
- data/docs/Recipients.md +17 -0
- data/docs/RecipientsUpdateSummary.md +8 -0
- data/docs/ReferralInformation.md +25 -0
- data/docs/Reminders.md +10 -0
- data/docs/ResourceInformation.md +8 -0
- data/docs/ReturnUrlRequest.md +8 -0
- data/docs/SamlAssertionAttribute.md +11 -0
- data/docs/SeatDiscount.md +10 -0
- data/docs/SenderEmailNotifications.md +14 -0
- data/docs/ServerTemplate.md +9 -0
- data/docs/ServiceInformation.md +13 -0
- data/docs/ServiceVersion.md +9 -0
- data/docs/SettingsMetadata.md +13 -0
- data/docs/SharedItem.md +10 -0
- data/docs/SignHere.md +34 -0
- data/docs/SignatureProviderRequiredOption.md +9 -0
- data/docs/SignatureType.md +9 -0
- data/docs/Signer.md +63 -0
- data/docs/SignerAttachment.md +34 -0
- data/docs/SignerEmailNotifications.md +21 -0
- data/docs/SigningGroup.md +17 -0
- data/docs/SigningGroupInformation.md +8 -0
- data/docs/SigningGroupUser.md +10 -0
- data/docs/SigningGroupUsers.md +8 -0
- data/docs/SigningGroupsApi.md +485 -0
- data/docs/SocialAccountInformation.md +12 -0
- data/docs/SocialAuthentication.md +8 -0
- data/docs/Ssn.md +52 -0
- data/docs/Ssn4InformationInput.md +10 -0
- data/docs/Ssn9InformationInput.md +9 -0
- data/docs/TabAccountSettings.md +45 -0
- data/docs/TabMetadata.md +46 -0
- data/docs/TabMetadataList.md +8 -0
- data/docs/Tabs.md +32 -0
- data/docs/TemplateCustomFields.md +9 -0
- data/docs/TemplateDocumentVisibilityList.md +8 -0
- data/docs/TemplateDocumentsResult.md +9 -0
- data/docs/TemplateInformation.md +8 -0
- data/docs/TemplateMatch.md +10 -0
- data/docs/TemplateNotificationRequest.md +11 -0
- data/docs/TemplateRecipients.md +17 -0
- data/docs/TemplateRole.md +19 -0
- data/docs/TemplateSharedItem.md +14 -0
- data/docs/TemplateSummary.md +14 -0
- data/docs/TemplateTabs.md +32 -0
- data/docs/TemplateUpdateSummary.md +15 -0
- data/docs/TemplatesApi.md +2349 -0
- data/docs/Text.md +55 -0
- data/docs/TextCustomField.md +14 -0
- data/docs/Title.md +46 -0
- data/docs/UsageHistory.md +11 -0
- data/docs/UserAccountManagementGranularInformation.md +15 -0
- data/docs/UserInfo.md +17 -0
- data/docs/UserInfoList.md +8 -0
- data/docs/UserInformation.md +41 -0
- data/docs/UserInformationList.md +14 -0
- data/docs/UserPasswordInformation.md +11 -0
- data/docs/UserProfile.md +19 -0
- data/docs/UserSettingsInformation.md +11 -0
- data/docs/UserSharedItem.md +10 -0
- data/docs/UserSignature.md +20 -0
- data/docs/UserSignatureDefinition.md +11 -0
- data/docs/UserSignaturesInformation.md +8 -0
- data/docs/UserSocialIdResult.md +9 -0
- data/docs/UsersApi.md +1566 -0
- data/docs/UsersResponse.md +14 -0
- data/docs/View.md +42 -0
- data/docs/ViewLinkRequest.md +9 -0
- data/docs/ViewUrl.md +8 -0
- data/docs/Workspace.md +18 -0
- data/docs/WorkspaceFolderContents.md +15 -0
- data/docs/WorkspaceItem.md +26 -0
- data/docs/WorkspaceItemList.md +8 -0
- data/docs/WorkspaceList.md +12 -0
- data/docs/WorkspaceUser.md +23 -0
- data/docs/WorkspaceUserAuthorization.md +18 -0
- data/docs/WorkspacesApi.md +630 -0
- data/docs/Zip.md +53 -0
- data/docusign_esign-1.0.0.gem +0 -0
- data/docusign_esign.gemspec +47 -0
- data/git_push.sh +55 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/accounts_api.rb +2230 -0
- data/lib/docusign_esign/api/authentication_api.rb +393 -0
- data/lib/docusign_esign/api/billing_api.rb +636 -0
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +355 -0
- data/lib/docusign_esign/api/cloud_storage_api.rb +507 -0
- data/lib/docusign_esign/api/connect_api.rb +967 -0
- data/lib/docusign_esign/api/custom_tabs_api.rb +296 -0
- data/lib/docusign_esign/api/diagnostics_api.rb +356 -0
- data/lib/docusign_esign/api/envelopes_api.rb +4737 -0
- data/lib/docusign_esign/api/folders_api.rb +342 -0
- data/lib/docusign_esign/api/groups_api.rb +596 -0
- data/lib/docusign_esign/api/power_forms_api.rb +489 -0
- data/lib/docusign_esign/api/signing_groups_api.rb +513 -0
- data/lib/docusign_esign/api/templates_api.rb +2555 -0
- data/lib/docusign_esign/api/users_api.rb +1694 -0
- data/lib/docusign_esign/api/workspaces_api.rb +719 -0
- data/lib/docusign_esign/api_client.rb +421 -0
- data/lib/docusign_esign/api_error.rb +37 -0
- data/lib/docusign_esign/configuration.rb +195 -0
- data/lib/docusign_esign/models/account_address.rb +300 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +384 -0
- data/lib/docusign_esign/models/account_billing_plan_response.rb +236 -0
- data/lib/docusign_esign/models/account_information.rb +488 -0
- data/lib/docusign_esign/models/account_role_settings.rb +786 -0
- data/lib/docusign_esign/models/account_settings_information.rb +190 -0
- data/lib/docusign_esign/models/account_shared_access.rb +269 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +252 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +208 -0
- data/lib/docusign_esign/models/account_signature_providers.rb +190 -0
- data/lib/docusign_esign/models/add_on.rb +218 -0
- data/lib/docusign_esign/models/address_information.rb +258 -0
- data/lib/docusign_esign/models/address_information_input.rb +207 -0
- data/lib/docusign_esign/models/address_information_v2.rb +258 -0
- data/lib/docusign_esign/models/agent.rb +603 -0
- data/lib/docusign_esign/models/api_request_log.rb +218 -0
- data/lib/docusign_esign/models/api_request_logs_result.rb +190 -0
- data/lib/docusign_esign/models/app_store_product.rb +198 -0
- data/lib/docusign_esign/models/app_store_receipt.rb +198 -0
- data/lib/docusign_esign/models/approve.rb +506 -0
- data/lib/docusign_esign/models/attachment.rb +248 -0
- data/lib/docusign_esign/models/authentication_method.rb +218 -0
- data/lib/docusign_esign/models/authentication_status.rb +331 -0
- data/lib/docusign_esign/models/bcc_email_address.rb +198 -0
- data/lib/docusign_esign/models/billing_charge.rb +312 -0
- data/lib/docusign_esign/models/billing_charge_response.rb +190 -0
- data/lib/docusign_esign/models/billing_discount.rb +208 -0
- data/lib/docusign_esign/models/billing_invoice.rb +280 -0
- data/lib/docusign_esign/models/billing_invoice_item.rb +228 -0
- data/lib/docusign_esign/models/billing_invoices_response.rb +210 -0
- data/lib/docusign_esign/models/billing_invoices_summary.rb +210 -0
- data/lib/docusign_esign/models/billing_payment.rb +208 -0
- data/lib/docusign_esign/models/billing_payment_item.rb +228 -0
- data/lib/docusign_esign/models/billing_payment_request.rb +188 -0
- data/lib/docusign_esign/models/billing_payment_response.rb +190 -0
- data/lib/docusign_esign/models/billing_payments_response.rb +210 -0
- data/lib/docusign_esign/models/billing_plan.rb +336 -0
- data/lib/docusign_esign/models/billing_plan_information.rb +323 -0
- data/lib/docusign_esign/models/billing_plan_preview.rb +237 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +199 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +247 -0
- data/lib/docusign_esign/models/billing_plans_response.rb +190 -0
- data/lib/docusign_esign/models/billing_price.rb +208 -0
- data/lib/docusign_esign/models/brand.rb +313 -0
- data/lib/docusign_esign/models/brand_email_content.rb +218 -0
- data/lib/docusign_esign/models/brand_link.rb +218 -0
- data/lib/docusign_esign/models/brand_logos.rb +208 -0
- data/lib/docusign_esign/models/brand_request.rb +188 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +218 -0
- data/lib/docusign_esign/models/brand_resources.rb +248 -0
- data/lib/docusign_esign/models/brand_resources_list.rb +190 -0
- data/lib/docusign_esign/models/brands_request.rb +190 -0
- data/lib/docusign_esign/models/brands_response.rb +210 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +267 -0
- data/lib/docusign_esign/models/bulk_envelope_status.rb +320 -0
- data/lib/docusign_esign/models/bulk_envelopes_response.rb +250 -0
- data/lib/docusign_esign/models/bulk_recipient.rb +284 -0
- data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +198 -0
- data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +198 -0
- data/lib/docusign_esign/models/bulk_recipients_request.rb +190 -0
- data/lib/docusign_esign/models/bulk_recipients_response.rb +250 -0
- data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +222 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +187 -0
- data/lib/docusign_esign/models/captive_recipient.rb +217 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +190 -0
- data/lib/docusign_esign/models/carbon_copy.rb +603 -0
- data/lib/docusign_esign/models/certified_delivery.rb +603 -0
- data/lib/docusign_esign/models/checkbox.rb +476 -0
- data/lib/docusign_esign/models/chunked_upload_part.rb +198 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +198 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +250 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +227 -0
- data/lib/docusign_esign/models/cloud_storage_providers.rb +190 -0
- data/lib/docusign_esign/models/company.rb +566 -0
- data/lib/docusign_esign/models/composite_template.rb +231 -0
- data/lib/docusign_esign/models/connect_config_results.rb +200 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +388 -0
- data/lib/docusign_esign/models/connect_debug_log.rb +227 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +200 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +228 -0
- data/lib/docusign_esign/models/connect_failure_results.rb +190 -0
- data/lib/docusign_esign/models/connect_log.rb +360 -0
- data/lib/docusign_esign/models/connect_logs.rb +222 -0
- data/lib/docusign_esign/models/console_view_request.rb +198 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +478 -0
- data/lib/docusign_esign/models/contact.rb +269 -0
- data/lib/docusign_esign/models/contact_get_response.rb +250 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +190 -0
- data/lib/docusign_esign/models/contact_update_response.rb +190 -0
- data/lib/docusign_esign/models/correct_view_request.rb +198 -0
- data/lib/docusign_esign/models/country.rb +220 -0
- data/lib/docusign_esign/models/credit_card_information.rb +237 -0
- data/lib/docusign_esign/models/credit_card_types.rb +190 -0
- data/lib/docusign_esign/models/currency_feature_set_price.rb +228 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +237 -0
- data/lib/docusign_esign/models/custom_field_v2.rb +247 -0
- data/lib/docusign_esign/models/custom_fields.rb +202 -0
- data/lib/docusign_esign/models/custom_fields_envelope.rb +202 -0
- data/lib/docusign_esign/models/custom_settings_information.rb +190 -0
- data/lib/docusign_esign/models/date.rb +626 -0
- data/lib/docusign_esign/models/date_signed.rb +496 -0
- data/lib/docusign_esign/models/decline.rb +516 -0
- data/lib/docusign_esign/models/diagnostics_settings_information.rb +208 -0
- data/lib/docusign_esign/models/dob_information_input.rb +208 -0
- data/lib/docusign_esign/models/document.rb +382 -0
- data/lib/docusign_esign/models/document_fields_information.rb +190 -0
- data/lib/docusign_esign/models/document_template.rb +227 -0
- data/lib/docusign_esign/models/document_template_list.rb +190 -0
- data/lib/docusign_esign/models/document_visibility.rb +227 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +190 -0
- data/lib/docusign_esign/models/e_note_configuration.rb +228 -0
- data/lib/docusign_esign/models/editor.rb +591 -0
- data/lib/docusign_esign/models/email.rb +626 -0
- data/lib/docusign_esign/models/email_address.rb +486 -0
- data/lib/docusign_esign/models/email_settings.rb +210 -0
- data/lib/docusign_esign/models/envelope.rb +643 -0
- data/lib/docusign_esign/models/envelope_attachment.rb +237 -0
- data/lib/docusign_esign/models/envelope_attachments_request.rb +190 -0
- data/lib/docusign_esign/models/envelope_attachments_result.rb +190 -0
- data/lib/docusign_esign/models/envelope_audit_event.rb +190 -0
- data/lib/docusign_esign/models/envelope_audit_event_response.rb +190 -0
- data/lib/docusign_esign/models/envelope_definition.rb +740 -0
- data/lib/docusign_esign/models/envelope_document.rb +351 -0
- data/lib/docusign_esign/models/envelope_documents_result.rb +200 -0
- data/lib/docusign_esign/models/envelope_event.rb +198 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +242 -0
- data/lib/docusign_esign/models/envelope_id.rb +486 -0
- data/lib/docusign_esign/models/envelope_ids_request.rb +202 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +206 -0
- data/lib/docusign_esign/models/envelope_summary.rb +218 -0
- data/lib/docusign_esign/models/envelope_template.rb +664 -0
- data/lib/docusign_esign/models/envelope_template_definition.rb +326 -0
- data/lib/docusign_esign/models/envelope_template_result.rb +784 -0
- data/lib/docusign_esign/models/envelope_template_results.rb +262 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +217 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +260 -0
- data/lib/docusign_esign/models/envelopes_information.rb +262 -0
- data/lib/docusign_esign/models/error_details.rb +198 -0
- data/lib/docusign_esign/models/event_notification.rb +332 -0
- data/lib/docusign_esign/models/event_result.rb +218 -0
- data/lib/docusign_esign/models/expirations.rb +208 -0
- data/lib/docusign_esign/models/external_doc_service_error_details.rb +208 -0
- data/lib/docusign_esign/models/external_file.rb +258 -0
- data/lib/docusign_esign/models/external_folder.rb +279 -0
- data/lib/docusign_esign/models/feature_set.rb +270 -0
- data/lib/docusign_esign/models/file_type.rb +198 -0
- data/lib/docusign_esign/models/file_type_list.rb +190 -0
- data/lib/docusign_esign/models/filter.rb +288 -0
- data/lib/docusign_esign/models/first_name.rb +486 -0
- data/lib/docusign_esign/models/folder.rb +298 -0
- data/lib/docusign_esign/models/folder_item.rb +390 -0
- data/lib/docusign_esign/models/folder_item_response.rb +250 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +377 -0
- data/lib/docusign_esign/models/folder_items_response.rb +250 -0
- data/lib/docusign_esign/models/folders_request.rb +200 -0
- data/lib/docusign_esign/models/folders_response.rb +190 -0
- data/lib/docusign_esign/models/forgotten_password_information.rb +258 -0
- data/lib/docusign_esign/models/formula_tab.rb +665 -0
- data/lib/docusign_esign/models/full_name.rb +486 -0
- data/lib/docusign_esign/models/group.rb +239 -0
- data/lib/docusign_esign/models/group_information.rb +250 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +214 -0
- data/lib/docusign_esign/models/in_person_signer.rb +729 -0
- data/lib/docusign_esign/models/initial_here.rb +446 -0
- data/lib/docusign_esign/models/inline_template.rb +227 -0
- data/lib/docusign_esign/models/integrated_user_info_list.rb +260 -0
- data/lib/docusign_esign/models/intermediary.rb +603 -0
- data/lib/docusign_esign/models/last_name.rb +486 -0
- data/lib/docusign_esign/models/list.rb +568 -0
- data/lib/docusign_esign/models/list_custom_field.rb +259 -0
- data/lib/docusign_esign/models/list_item.rb +208 -0
- data/lib/docusign_esign/models/lock_information.rb +256 -0
- data/lib/docusign_esign/models/lock_request.rb +228 -0
- data/lib/docusign_esign/models/login_account.rb +292 -0
- data/lib/docusign_esign/models/login_information.rb +200 -0
- data/lib/docusign_esign/models/match_box.rb +228 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +206 -0
- data/lib/docusign_esign/models/member_shared_items.rb +220 -0
- data/lib/docusign_esign/models/merge_field.rb +228 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +207 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +190 -0
- data/lib/docusign_esign/models/money.rb +208 -0
- data/lib/docusign_esign/models/name_value.rb +217 -0
- data/lib/docusign_esign/models/new_account_definition.rb +274 -0
- data/lib/docusign_esign/models/new_account_summary.rb +247 -0
- data/lib/docusign_esign/models/new_user.rb +277 -0
- data/lib/docusign_esign/models/new_users_definition.rb +190 -0
- data/lib/docusign_esign/models/new_users_summary.rb +190 -0
- data/lib/docusign_esign/models/notary_host.rb +577 -0
- data/lib/docusign_esign/models/note.rb +526 -0
- data/lib/docusign_esign/models/notification.rb +206 -0
- data/lib/docusign_esign/models/number.rb +646 -0
- data/lib/docusign_esign/models/oauth_access.rb +240 -0
- data/lib/docusign_esign/models/offline_attributes.rb +238 -0
- data/lib/docusign_esign/models/page.rb +257 -0
- data/lib/docusign_esign/models/page_images.rb +250 -0
- data/lib/docusign_esign/models/page_request.rb +198 -0
- data/lib/docusign_esign/models/payment_details.rb +229 -0
- data/lib/docusign_esign/models/payment_line_item.rb +218 -0
- data/lib/docusign_esign/models/permission_profile.rb +249 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +190 -0
- data/lib/docusign_esign/models/plan_information.rb +244 -0
- data/lib/docusign_esign/models/post_transactions_request.rb +218 -0
- data/lib/docusign_esign/models/post_transactions_response.rb +198 -0
- data/lib/docusign_esign/models/power_form.rb +421 -0
- data/lib/docusign_esign/models/power_form_form_data_envelope.rb +200 -0
- data/lib/docusign_esign/models/power_form_form_data_recipient.rb +220 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +308 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +250 -0
- data/lib/docusign_esign/models/power_forms_form_data_response.rb +190 -0
- data/lib/docusign_esign/models/power_forms_request.rb +190 -0
- data/lib/docusign_esign/models/power_forms_response.rb +250 -0
- data/lib/docusign_esign/models/property_metadata.rb +200 -0
- data/lib/docusign_esign/models/province.rb +198 -0
- data/lib/docusign_esign/models/provisioning_information.rb +248 -0
- data/lib/docusign_esign/models/purchased_envelopes_information.rb +268 -0
- data/lib/docusign_esign/models/radio.rb +357 -0
- data/lib/docusign_esign/models/radio_group.rb +270 -0
- data/lib/docusign_esign/models/recipient_attachment.rb +238 -0
- data/lib/docusign_esign/models/recipient_domain.rb +218 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +208 -0
- data/lib/docusign_esign/models/recipient_event.rb +198 -0
- data/lib/docusign_esign/models/recipient_form_data.rb +260 -0
- data/lib/docusign_esign/models/recipient_names_response.rb +210 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +220 -0
- data/lib/docusign_esign/models/recipient_saml_authentication.rb +190 -0
- data/lib/docusign_esign/models/recipient_signature_information.rb +208 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +197 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +218 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +190 -0
- data/lib/docusign_esign/models/recipient_update_response.rb +206 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +318 -0
- data/lib/docusign_esign/models/recipients.rb +291 -0
- data/lib/docusign_esign/models/recipients_update_summary.rb +190 -0
- data/lib/docusign_esign/models/referral_information.rb +358 -0
- data/lib/docusign_esign/models/reminders.rb +208 -0
- data/lib/docusign_esign/models/resource_information.rb +190 -0
- data/lib/docusign_esign/models/return_url_request.rb +188 -0
- data/lib/docusign_esign/models/saml_assertion_attribute.rb +217 -0
- data/lib/docusign_esign/models/seat_discount.rb +208 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +248 -0
- data/lib/docusign_esign/models/server_template.rb +198 -0
- data/lib/docusign_esign/models/service_information.rb +242 -0
- data/lib/docusign_esign/models/service_version.rb +198 -0
- data/lib/docusign_esign/models/settings_metadata.rb +240 -0
- data/lib/docusign_esign/models/shared_item.rb +206 -0
- data/lib/docusign_esign/models/sign_here.rb +446 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +200 -0
- data/lib/docusign_esign/models/signature_type.rb +198 -0
- data/lib/docusign_esign/models/signer.rb +742 -0
- data/lib/docusign_esign/models/signer_attachment.rb +446 -0
- data/lib/docusign_esign/models/signer_email_notifications.rb +318 -0
- data/lib/docusign_esign/models/signing_group.rb +279 -0
- data/lib/docusign_esign/models/signing_group_information.rb +190 -0
- data/lib/docusign_esign/models/signing_group_user.rb +207 -0
- data/lib/docusign_esign/models/signing_group_users.rb +190 -0
- data/lib/docusign_esign/models/social_account_information.rb +227 -0
- data/lib/docusign_esign/models/social_authentication.rb +188 -0
- data/lib/docusign_esign/models/ssn.rb +626 -0
- data/lib/docusign_esign/models/ssn4_information_input.rb +208 -0
- data/lib/docusign_esign/models/ssn9_information_input.rb +198 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +539 -0
- data/lib/docusign_esign/models/tab_metadata.rb +569 -0
- data/lib/docusign_esign/models/tab_metadata_list.rb +190 -0
- data/lib/docusign_esign/models/tabs.rb +478 -0
- data/lib/docusign_esign/models/template_custom_fields.rb +202 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +190 -0
- data/lib/docusign_esign/models/template_documents_result.rb +200 -0
- data/lib/docusign_esign/models/template_information.rb +190 -0
- data/lib/docusign_esign/models/template_match.rb +208 -0
- data/lib/docusign_esign/models/template_notification_request.rb +216 -0
- data/lib/docusign_esign/models/template_recipients.rb +291 -0
- data/lib/docusign_esign/models/template_role.rb +296 -0
- data/lib/docusign_esign/models/template_shared_item.rb +250 -0
- data/lib/docusign_esign/models/template_summary.rb +247 -0
- data/lib/docusign_esign/models/template_tabs.rb +478 -0
- data/lib/docusign_esign/models/template_update_summary.rb +260 -0
- data/lib/docusign_esign/models/text.rb +656 -0
- data/lib/docusign_esign/models/text_custom_field.rb +247 -0
- data/lib/docusign_esign/models/title.rb +566 -0
- data/lib/docusign_esign/models/usage_history.rb +218 -0
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +254 -0
- data/lib/docusign_esign/models/user_info.rb +277 -0
- data/lib/docusign_esign/models/user_info_list.rb +190 -0
- data/lib/docusign_esign/models/user_information.rb +519 -0
- data/lib/docusign_esign/models/user_information_list.rb +250 -0
- data/lib/docusign_esign/models/user_password_information.rb +217 -0
- data/lib/docusign_esign/models/user_profile.rb +297 -0
- data/lib/docusign_esign/models/user_settings_information.rb +217 -0
- data/lib/docusign_esign/models/user_shared_item.rb +206 -0
- data/lib/docusign_esign/models/user_signature.rb +307 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +218 -0
- data/lib/docusign_esign/models/user_signatures_information.rb +190 -0
- data/lib/docusign_esign/models/user_social_id_result.rb +200 -0
- data/lib/docusign_esign/models/users_response.rb +250 -0
- data/lib/docusign_esign/models/view.rb +526 -0
- data/lib/docusign_esign/models/view_link_request.rb +198 -0
- data/lib/docusign_esign/models/view_url.rb +188 -0
- data/lib/docusign_esign/models/workspace.rb +286 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +261 -0
- data/lib/docusign_esign/models/workspace_item.rb +365 -0
- data/lib/docusign_esign/models/workspace_item_list.rb +190 -0
- data/lib/docusign_esign/models/workspace_list.rb +230 -0
- data/lib/docusign_esign/models/workspace_user.rb +337 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +286 -0
- data/lib/docusign_esign/models/zip.rb +636 -0
- data/lib/docusign_esign/version.rb +14 -0
- data/lib/docusign_esign.rb +360 -0
- data/spec/api/accounts_api_spec.rb +556 -0
- data/spec/api/authentication_api_spec.rb +125 -0
- data/spec/api/billing_api_spec.rb +178 -0
- data/spec/api/bulk_envelopes_api_spec.rb +110 -0
- data/spec/api/cloud_storage_api_spec.rb +146 -0
- data/spec/api/connect_api_spec.rb +261 -0
- data/spec/api/custom_tabs_api_spec.rb +100 -0
- data/spec/api/diagnostics_api_spec.rb +114 -0
- data/spec/api/envelopes_api_spec.rb +1171 -0
- data/spec/api/folders_api_spec.rb +107 -0
- data/spec/api/groups_api_spec.rb +174 -0
- data/spec/api/power_forms_api_spec.rb +144 -0
- data/spec/api/signing_groups_api_spec.rb +155 -0
- data/spec/api/templates_api_spec.rb +649 -0
- data/spec/api/users_api_spec.rb +442 -0
- data/spec/api/workspaces_api_spec.rb +201 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/account_address_spec.rb +107 -0
- data/spec/models/account_billing_plan_response_spec.rb +71 -0
- data/spec/models/account_billing_plan_spec.rb +155 -0
- data/spec/models/account_information_spec.rb +221 -0
- data/spec/models/account_role_settings_spec.rb +419 -0
- data/spec/models/account_settings_information_spec.rb +41 -0
- data/spec/models/account_shared_access_spec.rb +89 -0
- data/spec/models/account_signature_provider_option_spec.rb +53 -0
- data/spec/models/account_signature_provider_spec.rb +77 -0
- data/spec/models/account_signature_providers_spec.rb +41 -0
- data/spec/models/add_on_spec.rb +59 -0
- data/spec/models/address_information_input_spec.rb +53 -0
- data/spec/models/address_information_spec.rb +83 -0
- data/spec/models/address_information_v2_spec.rb +83 -0
- data/spec/models/agent_spec.rb +287 -0
- data/spec/models/api_request_log_spec.rb +59 -0
- data/spec/models/api_request_logs_result_spec.rb +41 -0
- data/spec/models/app_store_product_spec.rb +47 -0
- data/spec/models/app_store_receipt_spec.rb +47 -0
- data/spec/models/approve_spec.rb +233 -0
- data/spec/models/attachment_spec.rb +77 -0
- data/spec/models/authentication_method_spec.rb +59 -0
- data/spec/models/authentication_status_spec.rb +137 -0
- data/spec/models/bcc_email_address_spec.rb +47 -0
- data/spec/models/billing_charge_response_spec.rb +41 -0
- data/spec/models/billing_charge_spec.rb +113 -0
- data/spec/models/billing_discount_spec.rb +53 -0
- data/spec/models/billing_invoice_item_spec.rb +65 -0
- data/spec/models/billing_invoice_spec.rb +95 -0
- data/spec/models/billing_invoices_response_spec.rb +53 -0
- data/spec/models/billing_invoices_summary_spec.rb +53 -0
- data/spec/models/billing_payment_item_spec.rb +65 -0
- data/spec/models/billing_payment_request_spec.rb +41 -0
- data/spec/models/billing_payment_response_spec.rb +41 -0
- data/spec/models/billing_payment_spec.rb +53 -0
- data/spec/models/billing_payments_response_spec.rb +53 -0
- data/spec/models/billing_plan_information_spec.rb +125 -0
- data/spec/models/billing_plan_preview_spec.rb +71 -0
- data/spec/models/billing_plan_response_spec.rb +47 -0
- data/spec/models/billing_plan_spec.rb +125 -0
- data/spec/models/billing_plan_update_response_spec.rb +77 -0
- data/spec/models/billing_plans_response_spec.rb +41 -0
- data/spec/models/billing_price_spec.rb +53 -0
- data/spec/models/brand_email_content_spec.rb +59 -0
- data/spec/models/brand_link_spec.rb +59 -0
- data/spec/models/brand_logos_spec.rb +53 -0
- data/spec/models/brand_request_spec.rb +41 -0
- data/spec/models/brand_resource_urls_spec.rb +59 -0
- data/spec/models/brand_resources_list_spec.rb +41 -0
- data/spec/models/brand_resources_spec.rb +77 -0
- data/spec/models/brand_spec.rb +113 -0
- data/spec/models/brands_request_spec.rb +41 -0
- data/spec/models/brands_response_spec.rb +53 -0
- data/spec/models/bulk_envelope_spec.rb +89 -0
- data/spec/models/bulk_envelope_status_spec.rb +119 -0
- data/spec/models/bulk_envelopes_response_spec.rb +77 -0
- data/spec/models/bulk_recipient_signature_provider_spec.rb +47 -0
- data/spec/models/bulk_recipient_spec.rb +95 -0
- data/spec/models/bulk_recipient_tab_label_spec.rb +47 -0
- data/spec/models/bulk_recipients_request_spec.rb +41 -0
- data/spec/models/bulk_recipients_response_spec.rb +77 -0
- data/spec/models/bulk_recipients_summary_response_spec.rb +59 -0
- data/spec/models/bulk_recipients_update_response_spec.rb +41 -0
- data/spec/models/captive_recipient_information_spec.rb +41 -0
- data/spec/models/captive_recipient_spec.rb +59 -0
- data/spec/models/carbon_copy_spec.rb +287 -0
- data/spec/models/certified_delivery_spec.rb +287 -0
- data/spec/models/checkbox_spec.rb +215 -0
- data/spec/models/chunked_upload_part_spec.rb +47 -0
- data/spec/models/chunked_upload_request_spec.rb +47 -0
- data/spec/models/chunked_upload_response_spec.rb +77 -0
- data/spec/models/cloud_storage_provider_spec.rb +65 -0
- data/spec/models/cloud_storage_providers_spec.rb +41 -0
- data/spec/models/company_spec.rb +269 -0
- data/spec/models/composite_template_spec.rb +65 -0
- data/spec/models/connect_config_results_spec.rb +47 -0
- data/spec/models/connect_custom_configuration_spec.rb +161 -0
- data/spec/models/connect_debug_log_spec.rb +65 -0
- data/spec/models/connect_failure_filter_spec.rb +47 -0
- data/spec/models/connect_failure_result_spec.rb +65 -0
- data/spec/models/connect_failure_results_spec.rb +41 -0
- data/spec/models/connect_log_spec.rb +143 -0
- data/spec/models/connect_logs_spec.rb +59 -0
- data/spec/models/console_view_request_spec.rb +47 -0
- data/spec/models/consumer_disclosure_spec.rb +215 -0
- data/spec/models/contact_get_response_spec.rb +77 -0
- data/spec/models/contact_mod_request_spec.rb +41 -0
- data/spec/models/contact_spec.rb +89 -0
- data/spec/models/contact_update_response_spec.rb +41 -0
- data/spec/models/correct_view_request_spec.rb +47 -0
- data/spec/models/country_spec.rb +59 -0
- data/spec/models/credit_card_information_spec.rb +71 -0
- data/spec/models/credit_card_types_spec.rb +41 -0
- data/spec/models/currency_feature_set_price_spec.rb +65 -0
- data/spec/models/currency_plan_price_spec.rb +71 -0
- data/spec/models/custom_field_v2_spec.rb +77 -0
- data/spec/models/custom_fields_envelope_spec.rb +47 -0
- data/spec/models/custom_fields_spec.rb +47 -0
- data/spec/models/custom_settings_information_spec.rb +41 -0
- data/spec/models/date_signed_spec.rb +227 -0
- data/spec/models/date_spec.rb +305 -0
- data/spec/models/decline_spec.rb +239 -0
- data/spec/models/diagnostics_settings_information_spec.rb +53 -0
- data/spec/models/dob_information_input_spec.rb +53 -0
- data/spec/models/document_fields_information_spec.rb +41 -0
- data/spec/models/document_spec.rb +155 -0
- data/spec/models/document_template_list_spec.rb +41 -0
- data/spec/models/document_template_spec.rb +65 -0
- data/spec/models/document_visibility_list_spec.rb +41 -0
- data/spec/models/document_visibility_spec.rb +65 -0
- data/spec/models/e_note_configuration_spec.rb +65 -0
- data/spec/models/editor_spec.rb +281 -0
- data/spec/models/email_address_spec.rb +221 -0
- data/spec/models/email_settings_spec.rb +53 -0
- data/spec/models/email_spec.rb +305 -0
- data/spec/models/envelope_attachment_spec.rb +71 -0
- data/spec/models/envelope_attachments_request_spec.rb +41 -0
- data/spec/models/envelope_attachments_result_spec.rb +41 -0
- data/spec/models/envelope_audit_event_response_spec.rb +41 -0
- data/spec/models/envelope_audit_event_spec.rb +41 -0
- data/spec/models/envelope_definition_spec.rb +371 -0
- data/spec/models/envelope_document_spec.rb +137 -0
- data/spec/models/envelope_documents_result_spec.rb +47 -0
- data/spec/models/envelope_event_spec.rb +47 -0
- data/spec/models/envelope_form_data_spec.rb +71 -0
- data/spec/models/envelope_id_spec.rb +221 -0
- data/spec/models/envelope_ids_request_spec.rb +47 -0
- data/spec/models/envelope_notification_request_spec.rb +53 -0
- data/spec/models/envelope_spec.rb +317 -0
- data/spec/models/envelope_summary_spec.rb +59 -0
- data/spec/models/envelope_template_definition_spec.rb +125 -0
- data/spec/models/envelope_template_result_spec.rb +401 -0
- data/spec/models/envelope_template_results_spec.rb +83 -0
- data/spec/models/envelope_template_spec.rb +329 -0
- data/spec/models/envelope_transaction_status_spec.rb +59 -0
- data/spec/models/envelope_update_summary_spec.rb +83 -0
- data/spec/models/envelopes_information_spec.rb +83 -0
- data/spec/models/error_details_spec.rb +47 -0
- data/spec/models/event_notification_spec.rb +125 -0
- data/spec/models/event_result_spec.rb +59 -0
- data/spec/models/expirations_spec.rb +53 -0
- data/spec/models/external_doc_service_error_details_spec.rb +53 -0
- data/spec/models/external_file_spec.rb +83 -0
- data/spec/models/external_folder_spec.rb +95 -0
- data/spec/models/feature_set_spec.rb +89 -0
- data/spec/models/file_type_list_spec.rb +41 -0
- data/spec/models/file_type_spec.rb +47 -0
- data/spec/models/filter_spec.rb +101 -0
- data/spec/models/first_name_spec.rb +221 -0
- data/spec/models/folder_item_response_spec.rb +77 -0
- data/spec/models/folder_item_spec.rb +161 -0
- data/spec/models/folder_item_v2_spec.rb +155 -0
- data/spec/models/folder_items_response_spec.rb +77 -0
- data/spec/models/folder_spec.rb +107 -0
- data/spec/models/folders_request_spec.rb +47 -0
- data/spec/models/folders_response_spec.rb +41 -0
- data/spec/models/forgotten_password_information_spec.rb +83 -0
- data/spec/models/formula_tab_spec.rb +329 -0
- data/spec/models/full_name_spec.rb +221 -0
- data/spec/models/group_information_spec.rb +77 -0
- data/spec/models/group_spec.rb +71 -0
- data/spec/models/id_check_information_input_spec.rb +59 -0
- data/spec/models/in_person_signer_spec.rb +365 -0
- data/spec/models/initial_here_spec.rb +197 -0
- data/spec/models/inline_template_spec.rb +65 -0
- data/spec/models/integrated_user_info_list_spec.rb +83 -0
- data/spec/models/intermediary_spec.rb +287 -0
- data/spec/models/last_name_spec.rb +221 -0
- data/spec/models/list_custom_field_spec.rb +83 -0
- data/spec/models/list_item_spec.rb +53 -0
- data/spec/models/list_spec.rb +269 -0
- data/spec/models/lock_information_spec.rb +83 -0
- data/spec/models/lock_request_spec.rb +65 -0
- data/spec/models/login_account_spec.rb +101 -0
- data/spec/models/login_information_spec.rb +47 -0
- data/spec/models/match_box_spec.rb +65 -0
- data/spec/models/member_group_shared_item_spec.rb +53 -0
- data/spec/models/member_shared_items_spec.rb +59 -0
- data/spec/models/merge_field_spec.rb +65 -0
- data/spec/models/mobile_notifier_configuration_information_spec.rb +41 -0
- data/spec/models/mobile_notifier_configuration_spec.rb +53 -0
- data/spec/models/money_spec.rb +53 -0
- data/spec/models/name_value_spec.rb +59 -0
- data/spec/models/new_account_definition_spec.rb +95 -0
- data/spec/models/new_account_summary_spec.rb +77 -0
- data/spec/models/new_user_spec.rb +95 -0
- data/spec/models/new_users_definition_spec.rb +41 -0
- data/spec/models/new_users_summary_spec.rb +41 -0
- data/spec/models/notary_host_spec.rb +275 -0
- data/spec/models/note_spec.rb +245 -0
- data/spec/models/notification_spec.rb +53 -0
- data/spec/models/number_spec.rb +317 -0
- data/spec/models/oauth_access_spec.rb +71 -0
- data/spec/models/offline_attributes_spec.rb +71 -0
- data/spec/models/page_images_spec.rb +77 -0
- data/spec/models/page_request_spec.rb +47 -0
- data/spec/models/page_spec.rb +83 -0
- data/spec/models/payment_details_spec.rb +65 -0
- data/spec/models/payment_line_item_spec.rb +59 -0
- data/spec/models/permission_profile_information_spec.rb +41 -0
- data/spec/models/permission_profile_spec.rb +77 -0
- data/spec/models/plan_information_spec.rb +71 -0
- data/spec/models/post_transactions_request_spec.rb +59 -0
- data/spec/models/post_transactions_response_spec.rb +47 -0
- data/spec/models/power_form_form_data_envelope_spec.rb +47 -0
- data/spec/models/power_form_form_data_recipient_spec.rb +59 -0
- data/spec/models/power_form_recipient_spec.rb +113 -0
- data/spec/models/power_form_senders_response_spec.rb +77 -0
- data/spec/models/power_form_spec.rb +179 -0
- data/spec/models/power_forms_form_data_response_spec.rb +41 -0
- data/spec/models/power_forms_request_spec.rb +41 -0
- data/spec/models/power_forms_response_spec.rb +77 -0
- data/spec/models/property_metadata_spec.rb +47 -0
- data/spec/models/province_spec.rb +47 -0
- data/spec/models/provisioning_information_spec.rb +77 -0
- data/spec/models/purchased_envelopes_information_spec.rb +89 -0
- data/spec/models/radio_group_spec.rb +89 -0
- data/spec/models/radio_spec.rb +143 -0
- data/spec/models/recipient_attachment_spec.rb +71 -0
- data/spec/models/recipient_domain_spec.rb +59 -0
- data/spec/models/recipient_email_notification_spec.rb +53 -0
- data/spec/models/recipient_event_spec.rb +47 -0
- data/spec/models/recipient_form_data_spec.rb +83 -0
- data/spec/models/recipient_names_response_spec.rb +53 -0
- data/spec/models/recipient_phone_authentication_spec.rb +59 -0
- data/spec/models/recipient_saml_authentication_spec.rb +41 -0
- data/spec/models/recipient_signature_information_spec.rb +53 -0
- data/spec/models/recipient_signature_provider_options_spec.rb +59 -0
- data/spec/models/recipient_signature_provider_spec.rb +47 -0
- data/spec/models/recipient_sms_authentication_spec.rb +41 -0
- data/spec/models/recipient_update_response_spec.rb +53 -0
- data/spec/models/recipient_view_request_spec.rb +119 -0
- data/spec/models/recipients_spec.rb +95 -0
- data/spec/models/recipients_update_summary_spec.rb +41 -0
- data/spec/models/referral_information_spec.rb +143 -0
- data/spec/models/reminders_spec.rb +53 -0
- data/spec/models/resource_information_spec.rb +41 -0
- data/spec/models/return_url_request_spec.rb +41 -0
- data/spec/models/saml_assertion_attribute_spec.rb +59 -0
- data/spec/models/seat_discount_spec.rb +53 -0
- data/spec/models/sender_email_notifications_spec.rb +77 -0
- data/spec/models/server_template_spec.rb +47 -0
- data/spec/models/service_information_spec.rb +71 -0
- data/spec/models/service_version_spec.rb +47 -0
- data/spec/models/settings_metadata_spec.rb +71 -0
- data/spec/models/shared_item_spec.rb +53 -0
- data/spec/models/sign_here_spec.rb +197 -0
- data/spec/models/signature_provider_required_option_spec.rb +47 -0
- data/spec/models/signature_type_spec.rb +47 -0
- data/spec/models/signer_attachment_spec.rb +197 -0
- data/spec/models/signer_email_notifications_spec.rb +119 -0
- data/spec/models/signer_spec.rb +371 -0
- data/spec/models/signing_group_information_spec.rb +41 -0
- data/spec/models/signing_group_spec.rb +95 -0
- data/spec/models/signing_group_user_spec.rb +53 -0
- data/spec/models/signing_group_users_spec.rb +41 -0
- data/spec/models/social_account_information_spec.rb +65 -0
- data/spec/models/social_authentication_spec.rb +41 -0
- data/spec/models/ssn4_information_input_spec.rb +53 -0
- data/spec/models/ssn9_information_input_spec.rb +47 -0
- data/spec/models/ssn_spec.rb +305 -0
- data/spec/models/tab_account_settings_spec.rb +263 -0
- data/spec/models/tab_metadata_list_spec.rb +41 -0
- data/spec/models/tab_metadata_spec.rb +269 -0
- data/spec/models/tabs_spec.rb +185 -0
- data/spec/models/template_custom_fields_spec.rb +47 -0
- data/spec/models/template_document_visibility_list_spec.rb +41 -0
- data/spec/models/template_documents_result_spec.rb +47 -0
- data/spec/models/template_information_spec.rb +41 -0
- data/spec/models/template_match_spec.rb +53 -0
- data/spec/models/template_notification_request_spec.rb +59 -0
- data/spec/models/template_recipients_spec.rb +95 -0
- data/spec/models/template_role_spec.rb +107 -0
- data/spec/models/template_shared_item_spec.rb +77 -0
- data/spec/models/template_summary_spec.rb +77 -0
- data/spec/models/template_tabs_spec.rb +185 -0
- data/spec/models/template_update_summary_spec.rb +83 -0
- data/spec/models/text_custom_field_spec.rb +77 -0
- data/spec/models/text_spec.rb +323 -0
- data/spec/models/title_spec.rb +269 -0
- data/spec/models/usage_history_spec.rb +59 -0
- data/spec/models/user_account_management_granular_information_spec.rb +83 -0
- data/spec/models/user_info_list_spec.rb +41 -0
- data/spec/models/user_info_spec.rb +95 -0
- data/spec/models/user_information_list_spec.rb +77 -0
- data/spec/models/user_information_spec.rb +239 -0
- data/spec/models/user_password_information_spec.rb +59 -0
- data/spec/models/user_profile_spec.rb +107 -0
- data/spec/models/user_settings_information_spec.rb +59 -0
- data/spec/models/user_shared_item_spec.rb +53 -0
- data/spec/models/user_signature_definition_spec.rb +59 -0
- data/spec/models/user_signature_spec.rb +113 -0
- data/spec/models/user_signatures_information_spec.rb +41 -0
- data/spec/models/user_social_id_result_spec.rb +47 -0
- data/spec/models/users_response_spec.rb +77 -0
- data/spec/models/view_link_request_spec.rb +47 -0
- data/spec/models/view_spec.rb +245 -0
- data/spec/models/view_url_spec.rb +41 -0
- data/spec/models/workspace_folder_contents_spec.rb +83 -0
- data/spec/models/workspace_item_list_spec.rb +41 -0
- data/spec/models/workspace_item_spec.rb +149 -0
- data/spec/models/workspace_list_spec.rb +65 -0
- data/spec/models/workspace_spec.rb +101 -0
- data/spec/models/workspace_user_authorization_spec.rb +101 -0
- data/spec/models/workspace_user_spec.rb +131 -0
- data/spec/models/zip_spec.rb +311 -0
- data/spec/spec_helper.rb +110 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile +5 -0
- data/tests/Gemfile.lock +42 -0
- data/tests/docs/Test.pdf +0 -0
- data/tests/rsa_keys/private.pem +27 -0
- data/tests/rsa_keys/public.pem +9 -0
- data/tests/spec/unit_tests_spec.rb +360 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +361 -0
- metadata +1560 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: d9e85ea7af791243aa55f544912b0616440b7854
|
|
4
|
+
data.tar.gz: 6cbb38fed3d1f46aea0c222b83b77a32f06f738c
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 9b0bdbb47fdb740c4584d77195041cec159e7aaa2018e8547a87b6b7387c70a291fbaebf7cdcfdc3c64ddbcecfd8b58054b270fd4571aca3147dab41012f624b
|
|
7
|
+
data.tar.gz: dc8deda4e61e6054bcd903d062b615e859ef80039ef8d9882d36e544e2357cc4f755564799596841efa005fcb63bed7d858aded92cfd8b6bb759565ee1ceb44c
|
data/Gemfile
ADDED
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2016- DocuSign, Inc. (https://www.docusign.com)
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# DocuSign Ruby Client
|
|
2
|
+
|
|
3
|
+
You can sign up for a free [developer sandbox](https://www.docusign.com/developer-center).
|
|
4
|
+
|
|
5
|
+
Requirements
|
|
6
|
+
============
|
|
7
|
+
|
|
8
|
+
Ruby 2.0.0 or higher [https://www.ruby-lang.org/en/].
|
|
9
|
+
|
|
10
|
+
Installation
|
|
11
|
+
============
|
|
12
|
+
|
|
13
|
+
Add this line to your application's Gemfile:
|
|
14
|
+
|
|
15
|
+
gem 'docusign_esign'
|
|
16
|
+
|
|
17
|
+
And then execute:
|
|
18
|
+
|
|
19
|
+
$ bundle install
|
|
20
|
+
|
|
21
|
+
Or install it yourself as:
|
|
22
|
+
|
|
23
|
+
$ gem install docusign_esign
|
|
24
|
+
|
|
25
|
+
Usage
|
|
26
|
+
=====
|
|
27
|
+
|
|
28
|
+
To initialize the client and make the Login API Call using the JWT authentication:
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'docusign_esign'
|
|
32
|
+
require 'uri'
|
|
33
|
+
|
|
34
|
+
host = 'https://demo.docusign.net/restapi'
|
|
35
|
+
integrator_key = '[REQUIRED]'
|
|
36
|
+
user_id = '[REQUIRED]'
|
|
37
|
+
expires_in_seconds = 3600 #1 hour
|
|
38
|
+
auth_server = 'account-d.docusign.com'
|
|
39
|
+
private_key_filename = '[REQUIRED]'
|
|
40
|
+
|
|
41
|
+
# STEP 1: Initialize API Client
|
|
42
|
+
configuration = DocuSign_eSign::Configuration.new
|
|
43
|
+
configuration.host = host
|
|
44
|
+
|
|
45
|
+
api_client = DocuSign_eSign::ApiClient.new(configuration)
|
|
46
|
+
api_client.configure_jwt_authorization_flow(private_key_filename, auth_server, integrator_key, user_id, expires_in_seconds)
|
|
47
|
+
|
|
48
|
+
# STEP 2: Initialize Authentication API using the API Client
|
|
49
|
+
authentication_api = DocuSign_eSign::AuthenticationApi.new(api_client)
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
# STEP 3: Make the login call
|
|
53
|
+
login_options = DocuSign_eSign::LoginOptions.new
|
|
54
|
+
login_information = authentication_api.login(login_options)
|
|
55
|
+
|
|
56
|
+
if !login_information.nil?
|
|
57
|
+
login_information.login_accounts.each do |login_account|
|
|
58
|
+
if login_account.is_default == "true"
|
|
59
|
+
# STEP 4: Extract the user information
|
|
60
|
+
base_url = login_account.base_url
|
|
61
|
+
account_id = login_account.account_id
|
|
62
|
+
|
|
63
|
+
puts base_url
|
|
64
|
+
puts account_id
|
|
65
|
+
|
|
66
|
+
# IMPORTANT: Use the base url from the login account to update the api client which will be used in future api calls
|
|
67
|
+
base_uri = URI.parse(base_url)
|
|
68
|
+
api_client.config.host = "%s://%s/restapi" % [base_uri.scheme, base_uri.host]
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
See [unit_tests_using_jwt_spec.rb](./tests/spec/unit_tests_using_jwt_spec.rb) for more examples.
|
|
75
|
+
|
|
76
|
+
Testing
|
|
77
|
+
=======
|
|
78
|
+
|
|
79
|
+
Unit tests are available in the [tests/spec](./tests/spec) folder.
|
|
80
|
+
|
|
81
|
+
Follow the steps below to run the test cases
|
|
82
|
+
|
|
83
|
+
* Fill in all the required fields/values
|
|
84
|
+
* Run the following command from the [tests/spec](./tests/spec) folder
|
|
85
|
+
|
|
86
|
+
bundle exec rspec <spec_filename>
|
|
87
|
+
|
|
88
|
+
Support
|
|
89
|
+
=======
|
|
90
|
+
|
|
91
|
+
Feel free to log issues against this client through GitHub. We also have an active developer community on Stack Overflow, search the [DocuSignAPI](http://stackoverflow.com/questions/tagged/docusignapi) tag.
|
|
92
|
+
|
|
93
|
+
License
|
|
94
|
+
=======
|
|
95
|
+
|
|
96
|
+
The DocuSign Ruby Client is licensed under the following [License](LICENSE).
|
|
97
|
+
|
|
98
|
+
Notes
|
|
99
|
+
=======
|
|
100
|
+
|
|
101
|
+
This version of the client library does not implement all of the DocuSign REST API methods. The current client omits methods in the Accounts, Billing, Cloud Storage, Connect, Groups (Branding), and Templates (Bulk Recipients) categories. The client's methods support the core set of use cases that most integrations will encounter. For a complete list of omitted endpoints, see [Omitted Endpoints](./omitted_endpoints.md).
|
data/Rakefile
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**address1** | **String** | First Line of the address. Maximum length: 100 characters. | [optional]
|
|
7
|
+
**address2** | **String** | Second Line of the address. Maximum length: 100 characters. | [optional]
|
|
8
|
+
**city** | **String** | The city value of the address. | [optional]
|
|
9
|
+
**country** | **String** | Specifies the country associated with the address. | [optional]
|
|
10
|
+
**email** | **String** | | [optional]
|
|
11
|
+
**fax** | **String** | | [optional]
|
|
12
|
+
**first_name** | **String** | The user’s first name. Maximum Length: 50 characters. | [optional]
|
|
13
|
+
**last_name** | **String** | | [optional]
|
|
14
|
+
**phone** | **String** | | [optional]
|
|
15
|
+
**postal_code** | **String** | | [optional]
|
|
16
|
+
**state** | **String** | The state or province associated with the address. | [optional]
|
|
17
|
+
**supported_countries** | [**Array<Country>**](Country.md) | Contains an array of countries supported by the billing plan. | [optional]
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountBillingPlan
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**add_ons** | [**Array<AddOn>**](AddOn.md) | Reserved: | [optional]
|
|
7
|
+
**can_cancel_renewal** | **String** | Reserved: TBD | [optional]
|
|
8
|
+
**can_upgrade** | **String** | When set to **true**, specifies that you can upgrade the account through the API. | [optional]
|
|
9
|
+
**currency_code** | **String** | Specifies the ISO currency code for the account. | [optional]
|
|
10
|
+
**enable_support** | **String** | When set to **true**, then customer support is provided as part of the account plan. | [optional]
|
|
11
|
+
**included_seats** | **String** | The number of seats (users) included. | [optional]
|
|
12
|
+
**incremental_seats** | **String** | Reserved: TBD | [optional]
|
|
13
|
+
**is_downgrade** | **String** | | [optional]
|
|
14
|
+
**other_discount_percent** | **String** | Any other percentage discount for the plan. | [optional]
|
|
15
|
+
**payment_cycle** | **String** | | [optional]
|
|
16
|
+
**payment_method** | **String** | The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. | [optional]
|
|
17
|
+
**per_seat_price** | **String** | | [optional]
|
|
18
|
+
**plan_classification** | **String** | Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. | [optional]
|
|
19
|
+
**plan_feature_sets** | [**Array<FeatureSet>**](FeatureSet.md) | A complex type that sets the feature sets for the account. It contains the following information (all string content): * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). * featureSetId - A unique ID for the feature set. * fixedFee - A one-time fee associated with the plan (when isEnabled=true). * isActive - Specifies whether the feature set is actively set as part of the plan. * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. * name - The name of the feature set. * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). | [optional]
|
|
20
|
+
**plan_id** | **String** | | [optional]
|
|
21
|
+
**plan_name** | **String** | The name of the Billing Plan. | [optional]
|
|
22
|
+
**renewal_status** | **String** | The renewal status for the account. The acceptable values are: * auto: The account automatically renews. * queued_for_close: Account will be closed at the billingPeriodEndDate. * queued_for_downgrade: Account will be downgraded at the billingPeriodEndDate. | [optional]
|
|
23
|
+
**seat_discounts** | [**Array<SeatDiscount>**](SeatDiscount.md) | A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. | [optional]
|
|
24
|
+
**support_incident_fee** | **String** | The support incident fee charged for each support incident. | [optional]
|
|
25
|
+
**support_plan_fee** | **String** | The support plan fee charged for this plan. | [optional]
|
|
26
|
+
|
|
27
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountBillingPlanResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**billing_address** | [**AccountAddress**](AccountAddress.md) | | [optional]
|
|
7
|
+
**billing_address_is_credit_card_address** | **String** | When set to **true**, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different. | [optional]
|
|
8
|
+
**billing_plan** | [**AccountBillingPlan**](AccountBillingPlan.md) | | [optional]
|
|
9
|
+
**credit_card_information** | [**CreditCardInformation**](CreditCardInformation.md) | | [optional]
|
|
10
|
+
**referral_information** | [**ReferralInformation**](ReferralInformation.md) | | [optional]
|
|
11
|
+
**successor_plans** | [**Array<BillingPlan>**](BillingPlan.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**account_id_guid** | **String** | The GUID associated with the account ID. | [optional]
|
|
7
|
+
**account_name** | **String** | The name of the current account. | [optional]
|
|
8
|
+
**allow_transaction_rooms** | **String** | When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled. | [optional]
|
|
9
|
+
**billing_period_days_remaining** | **String** | Reserved: TBD | [optional]
|
|
10
|
+
**billing_period_end_date** | **String** | Reserved: TBD | [optional]
|
|
11
|
+
**billing_period_envelopes_allowed** | **String** | Reserved: TBD | [optional]
|
|
12
|
+
**billing_period_envelopes_sent** | **String** | Reserved: TBD | [optional]
|
|
13
|
+
**billing_period_start_date** | **String** | Reserved: TBD | [optional]
|
|
14
|
+
**billing_profile** | **String** | Reserved: TBD | [optional]
|
|
15
|
+
**can_cancel_renewal** | **String** | Reserved: TBD | [optional]
|
|
16
|
+
**can_upgrade** | **String** | When set to **true**, specifies that you can upgrade the account through the API. | [optional]
|
|
17
|
+
**connect_permission** | **String** | | [optional]
|
|
18
|
+
**created_date** | **String** | | [optional]
|
|
19
|
+
**currency_code** | **String** | Specifies the ISO currency code for the account. | [optional]
|
|
20
|
+
**current_plan_id** | **String** | Identifies the plan that was used create this account. | [optional]
|
|
21
|
+
**distributor_code** | **String** | The code that identifies the billing plan groups and plans for the new account. | [optional]
|
|
22
|
+
**docu_sign_landing_url** | **String** | | [optional]
|
|
23
|
+
**envelope_sending_blocked** | **String** | | [optional]
|
|
24
|
+
**envelope_unit_price** | **String** | | [optional]
|
|
25
|
+
**forgotten_password_questions_count** | **String** | A complex element that contains up to four Question/Answer pairs for forgotten password information for a user. | [optional]
|
|
26
|
+
**is_downgrade** | **String** | | [optional]
|
|
27
|
+
**payment_method** | **String** | | [optional]
|
|
28
|
+
**plan_classification** | **String** | Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. | [optional]
|
|
29
|
+
**plan_end_date** | **String** | The date that the current plan will end. | [optional]
|
|
30
|
+
**plan_name** | **String** | The name of the Billing Plan. | [optional]
|
|
31
|
+
**plan_start_date** | **String** | The date that the Account started using the current plan. | [optional]
|
|
32
|
+
**seats_allowed** | **String** | | [optional]
|
|
33
|
+
**seats_in_use** | **String** | | [optional]
|
|
34
|
+
**status21_cfr_part11** | **String** | | [optional]
|
|
35
|
+
**suspension_date** | **String** | | [optional]
|
|
36
|
+
**suspension_status** | **String** | | [optional]
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountRoleSettings
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**allow_account_management** | **String** | | [optional]
|
|
7
|
+
**allow_account_management_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
8
|
+
**allow_api_access** | **String** | | [optional]
|
|
9
|
+
**allow_api_access_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
10
|
+
**allow_api_access_to_account** | **String** | | [optional]
|
|
11
|
+
**allow_api_access_to_account_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
12
|
+
**allow_api_sending_on_behalf_of_others** | **String** | | [optional]
|
|
13
|
+
**allow_api_sending_on_behalf_of_others_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
14
|
+
**allow_api_sequential_signing** | **String** | | [optional]
|
|
15
|
+
**allow_api_sequential_signing_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
16
|
+
**allow_bulk_sending** | **String** | | [optional]
|
|
17
|
+
**allow_bulk_sending_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
18
|
+
**allow_docu_sign_desktop_client** | **String** | | [optional]
|
|
19
|
+
**allow_docu_sign_desktop_client_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
20
|
+
**allowed_address_book_access** | **String** | | [optional]
|
|
21
|
+
**allowed_address_book_access_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
22
|
+
**allowed_template_access** | **String** | | [optional]
|
|
23
|
+
**allowed_template_access_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
24
|
+
**allowed_to_be_envelope_transfer_recipient** | **String** | | [optional]
|
|
25
|
+
**allowed_to_be_envelope_transfer_recipient_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
26
|
+
**allow_envelope_sending** | **String** | | [optional]
|
|
27
|
+
**allow_envelope_sending_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
28
|
+
**allow_senders_to_set_recipient_email_language** | **String** | | [optional]
|
|
29
|
+
**allow_senders_to_set_recipient_email_language_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
30
|
+
**allow_signer_attachments** | **String** | | [optional]
|
|
31
|
+
**allow_signer_attachments_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
32
|
+
**allow_supplemental_documents** | **String** | | [optional]
|
|
33
|
+
**allow_supplemental_documents_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
34
|
+
**allow_tagging_in_send_and_correct** | **String** | | [optional]
|
|
35
|
+
**allow_tagging_in_send_and_correct_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
36
|
+
**allow_vaulting** | **String** | | [optional]
|
|
37
|
+
**allow_vaulting_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
38
|
+
**allow_wet_signing_override** | **String** | | [optional]
|
|
39
|
+
**allow_wet_signing_override_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
40
|
+
**can_create_workspaces** | **String** | | [optional]
|
|
41
|
+
**can_create_workspaces_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
42
|
+
**disable_document_upload** | **String** | | [optional]
|
|
43
|
+
**disable_document_upload_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
44
|
+
**disable_other_actions** | **String** | | [optional]
|
|
45
|
+
**disable_other_actions_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
46
|
+
**enable_api_request_logging** | **String** | | [optional]
|
|
47
|
+
**enable_api_request_logging_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
48
|
+
**enable_recipient_viewing_notifications** | **String** | | [optional]
|
|
49
|
+
**enable_recipient_viewing_notifications_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
50
|
+
**enable_sequential_signing_interface** | **String** | | [optional]
|
|
51
|
+
**enable_sequential_signing_interface_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
52
|
+
**enable_transaction_point_integration** | **String** | | [optional]
|
|
53
|
+
**enable_transaction_point_integration_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
54
|
+
**power_form_role** | **String** | | [optional]
|
|
55
|
+
**power_form_role_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
56
|
+
**receive_completed_self_signed_documents_as_email_links** | **String** | | [optional]
|
|
57
|
+
**receive_completed_self_signed_documents_as_email_links_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
58
|
+
**supplemental_documents_must_accept** | **String** | | [optional]
|
|
59
|
+
**supplemental_documents_must_accept_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
60
|
+
**supplemental_documents_must_read** | **String** | | [optional]
|
|
61
|
+
**supplemental_documents_must_read_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
62
|
+
**supplemental_documents_must_view** | **String** | | [optional]
|
|
63
|
+
**supplemental_documents_must_view_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
64
|
+
**use_new_docu_sign_experience_interface** | **String** | | [optional]
|
|
65
|
+
**use_new_docu_sign_experience_interface_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
66
|
+
**use_new_sending_interface** | **String** | | [optional]
|
|
67
|
+
**use_new_sending_interface_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
68
|
+
**vaulting_mode** | **String** | | [optional]
|
|
69
|
+
**vaulting_mode_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
|
70
|
+
|
|
71
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountSettingsInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**account_settings** | [**Array<NameValue>**](NameValue.md) | The list of account settings. These determine the features available for the account. Note that some features are determined by the plan used to create the account, and cannot be overridden. | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountSharedAccess
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**account_id** | **String** | The account ID associated with the envelope. | [optional]
|
|
7
|
+
**end_position** | **String** | The last position in the result set. | [optional]
|
|
8
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
9
|
+
**next_uri** | **String** | The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. | [optional]
|
|
10
|
+
**previous_uri** | **String** | The postal code for the billing address. | [optional]
|
|
11
|
+
**result_set_size** | **String** | The number of results returned in this response. | [optional]
|
|
12
|
+
**shared_access** | [**Array<MemberSharedItems>**](MemberSharedItems.md) | A complex type containing the shared access information to an envelope for the users specified in the request. | [optional]
|
|
13
|
+
**start_position** | **String** | Starting position of the current result set. | [optional]
|
|
14
|
+
**total_set_size** | **String** | The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountSignatureProvider
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**is_required** | **String** | | [optional]
|
|
7
|
+
**priority** | **String** | | [optional]
|
|
8
|
+
**signature_provider_display_name** | **String** | | [optional]
|
|
9
|
+
**signature_provider_id** | **String** | | [optional]
|
|
10
|
+
**signature_provider_name** | **String** | | [optional]
|
|
11
|
+
**signature_provider_options_metadata** | [**Array<AccountSignatureProviderOption>**](AccountSignatureProviderOption.md) | | [optional]
|
|
12
|
+
**signature_provider_required_options** | [**Array<SignatureProviderRequiredOption>**](SignatureProviderRequiredOption.md) | | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountSignatureProviderOption
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**signature_provider_option_display_name** | **String** | | [optional]
|
|
7
|
+
**signature_provider_option_id** | **String** | | [optional]
|
|
8
|
+
**signature_provider_option_name** | **String** | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountSignatureProviders
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**signature_providers** | [**Array<AccountSignatureProvider>**](AccountSignatureProvider.md) | | [optional]
|
|
7
|
+
|
|
8
|
+
|
data/docs/AccountsApi.md
ADDED
|
@@ -0,0 +1,1997 @@
|
|
|
1
|
+
# DocuSign_eSign::AccountsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://www.docusign.net/restapi*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create**](AccountsApi.md#create) | **POST** /v2/accounts | Creates new accounts.
|
|
8
|
+
[**create_brand**](AccountsApi.md#create_brand) | **POST** /v2/accounts/{accountId}/brands | Creates one or more brand profile files for the account.
|
|
9
|
+
[**create_e_mortgage_transaction**](AccountsApi.md#create_e_mortgage_transaction) | **POST** /v2/accounts/{accountId}/eMortgage/transactions | Starts a new eMortgage Transaction
|
|
10
|
+
[**create_permission_profile**](AccountsApi.md#create_permission_profile) | **POST** /v2/accounts/{accountId}/permission_profiles | Creates a new permission profile in the specified account.
|
|
11
|
+
[**delete**](AccountsApi.md#delete) | **DELETE** /v2/accounts/{accountId} | Deletes the specified account.
|
|
12
|
+
[**delete_brand**](AccountsApi.md#delete_brand) | **DELETE** /v2/accounts/{accountId}/brands/{brandId} | Removes a brand.
|
|
13
|
+
[**delete_brand_logo_by_type**](AccountsApi.md#delete_brand_logo_by_type) | **DELETE** /v2/accounts/{accountId}/brands/{brandId}/logos/{logoType} | Delete one branding logo.
|
|
14
|
+
[**delete_brands**](AccountsApi.md#delete_brands) | **DELETE** /v2/accounts/{accountId}/brands | Deletes one or more brand profiles.
|
|
15
|
+
[**delete_captive_recipient**](AccountsApi.md#delete_captive_recipient) | **DELETE** /v2/accounts/{accountId}/captive_recipients/{recipientPart} | Deletes the signature for one or more captive recipient records.
|
|
16
|
+
[**delete_e_note_configuration**](AccountsApi.md#delete_e_note_configuration) | **DELETE** /v2/accounts/{accountId}/settings/enote_configuration | Deletes configuration information for the eNote eOriginal integration.
|
|
17
|
+
[**delete_permission_profile**](AccountsApi.md#delete_permission_profile) | **DELETE** /v2/accounts/{accountId}/permission_profiles/{permissionProfileId} | Deletes a permissions profile within the specified account.
|
|
18
|
+
[**get_account_information**](AccountsApi.md#get_account_information) | **GET** /v2/accounts/{accountId} | Retrieves the account information for the specified account.
|
|
19
|
+
[**get_account_tab_settings**](AccountsApi.md#get_account_tab_settings) | **GET** /v2/accounts/{accountId}/settings/tabs | Returns tab settings list for specified account
|
|
20
|
+
[**get_billing_charges**](AccountsApi.md#get_billing_charges) | **GET** /v2/accounts/{accountId}/billing_charges | Gets list of recurring and usage charges for the account.
|
|
21
|
+
[**get_brand**](AccountsApi.md#get_brand) | **GET** /v2/accounts/{accountId}/brands/{brandId} | Get information for a specific brand.
|
|
22
|
+
[**get_brand_logo_by_type**](AccountsApi.md#get_brand_logo_by_type) | **GET** /v2/accounts/{accountId}/brands/{brandId}/logos/{logoType} | Obtains the specified image for a brand.
|
|
23
|
+
[**get_brand_resources**](AccountsApi.md#get_brand_resources) | **GET** /v2/accounts/{accountId}/brands/{brandId}/resources | Returns the specified account's list of branding resources (metadata).
|
|
24
|
+
[**get_brand_resources_by_content_type**](AccountsApi.md#get_brand_resources_by_content_type) | **GET** /v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} | Returns the specified branding resource file.
|
|
25
|
+
[**get_consumer_disclosure**](AccountsApi.md#get_consumer_disclosure) | **GET** /v2/accounts/{accountId}/consumer_disclosure/{langCode} | Gets the Electronic Record and Signature Disclosure.
|
|
26
|
+
[**get_consumer_disclosure_default**](AccountsApi.md#get_consumer_disclosure_default) | **GET** /v2/accounts/{accountId}/consumer_disclosure | Gets the Electronic Record and Signature Disclosure for the account.
|
|
27
|
+
[**get_e_note_configuration**](AccountsApi.md#get_e_note_configuration) | **GET** /v2/accounts/{accountId}/settings/enote_configuration | Returns the configuration information for the eNote eOriginal integration.
|
|
28
|
+
[**get_permission_profile**](AccountsApi.md#get_permission_profile) | **GET** /v2/accounts/{accountId}/permission_profiles/{permissionProfileId} | Returns a permissions profile in the specified account.
|
|
29
|
+
[**get_provisioning**](AccountsApi.md#get_provisioning) | **GET** /v2/accounts/provisioning | Retrieves the account provisioning information for the account.
|
|
30
|
+
[**list_brands**](AccountsApi.md#list_brands) | **GET** /v2/accounts/{accountId}/brands | Gets a list of brand profiles.
|
|
31
|
+
[**list_custom_fields**](AccountsApi.md#list_custom_fields) | **GET** /v2/accounts/{accountId}/custom_fields | Gets a list of custom fields associated with the account.
|
|
32
|
+
[**list_permissions**](AccountsApi.md#list_permissions) | **GET** /v2/accounts/{accountId}/permission_profiles | Gets a list of permission profiles.
|
|
33
|
+
[**list_recipient_names_by_email**](AccountsApi.md#list_recipient_names_by_email) | **GET** /v2/accounts/{accountId}/recipient_names | Gets recipient names associated with an email address.
|
|
34
|
+
[**list_settings**](AccountsApi.md#list_settings) | **GET** /v2/accounts/{accountId}/settings | Gets account settings information.
|
|
35
|
+
[**list_shared_access**](AccountsApi.md#list_shared_access) | **GET** /v2/accounts/{accountId}/shared_access | Reserved: Gets the shared item status for one or more users.
|
|
36
|
+
[**list_signature_providers**](AccountsApi.md#list_signature_providers) | **GET** /v2/accounts/{accountId}/signatureProviders | Returns Account available signature providers for specified account.
|
|
37
|
+
[**list_unsupported_file_types**](AccountsApi.md#list_unsupported_file_types) | **GET** /v2/accounts/{accountId}/unsupported_file_types | Gets a list of unsupported file types.
|
|
38
|
+
[**update_account_tab_settings**](AccountsApi.md#update_account_tab_settings) | **PUT** /v2/accounts/{accountId}/settings/tabs | Modifies tab settings for specified account
|
|
39
|
+
[**update_brand**](AccountsApi.md#update_brand) | **PUT** /v2/accounts/{accountId}/brands/{brandId} | Updates an existing brand.
|
|
40
|
+
[**update_brand_logo_by_type**](AccountsApi.md#update_brand_logo_by_type) | **PUT** /v2/accounts/{accountId}/brands/{brandId}/logos/{logoType} | Put one branding logo.
|
|
41
|
+
[**update_brand_resources_by_content_type**](AccountsApi.md#update_brand_resources_by_content_type) | **PUT** /v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} | Uploads a branding resource file.
|
|
42
|
+
[**update_e_note_configuration**](AccountsApi.md#update_e_note_configuration) | **PUT** /v2/accounts/{accountId}/settings/enote_configuration | Updates configuration information for the eNote eOriginal integration.
|
|
43
|
+
[**update_permission_profile**](AccountsApi.md#update_permission_profile) | **PUT** /v2/accounts/{accountId}/permission_profiles/{permissionProfileId} | Updates a permission profile within the specified account.
|
|
44
|
+
[**update_settings**](AccountsApi.md#update_settings) | **PUT** /v2/accounts/{accountId}/settings | Updates the account settings for an account.
|
|
45
|
+
[**update_shared_access**](AccountsApi.md#update_shared_access) | **PUT** /v2/accounts/{accountId}/shared_access | Reserved: Sets the shared access information for users.
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
# **create**
|
|
49
|
+
> NewAccountSummary create(opts)
|
|
50
|
+
|
|
51
|
+
Creates new accounts.
|
|
52
|
+
|
|
53
|
+
Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a `newAccountRequests` element. A maximum of 100 new accounts can be created at one time. Note that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed.
|
|
54
|
+
|
|
55
|
+
### Example
|
|
56
|
+
```ruby
|
|
57
|
+
# load the gem
|
|
58
|
+
require 'docusign_esign'
|
|
59
|
+
|
|
60
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
61
|
+
|
|
62
|
+
opts = {
|
|
63
|
+
preview_billing_plan: "preview_billing_plan_example", # String | When set to **true**, creates the account using a preview billing plan.
|
|
64
|
+
new_account_definition: DocuSign_eSign::NewAccountDefinition.new # NewAccountDefinition |
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
begin
|
|
68
|
+
#Creates new accounts.
|
|
69
|
+
result = api_instance.create(opts)
|
|
70
|
+
p result
|
|
71
|
+
rescue DocuSign_eSign::ApiError => e
|
|
72
|
+
puts "Exception when calling AccountsApi->create: #{e}"
|
|
73
|
+
end
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Parameters
|
|
77
|
+
|
|
78
|
+
Name | Type | Description | Notes
|
|
79
|
+
------------- | ------------- | ------------- | -------------
|
|
80
|
+
**preview_billing_plan** | **String**| When set to **true**, creates the account using a preview billing plan. | [optional]
|
|
81
|
+
**new_account_definition** | [**NewAccountDefinition**](NewAccountDefinition.md)| | [optional]
|
|
82
|
+
|
|
83
|
+
### Return type
|
|
84
|
+
|
|
85
|
+
[**NewAccountSummary**](NewAccountSummary.md)
|
|
86
|
+
|
|
87
|
+
### Authorization
|
|
88
|
+
|
|
89
|
+
No authorization required
|
|
90
|
+
|
|
91
|
+
### HTTP request headers
|
|
92
|
+
|
|
93
|
+
- **Content-Type**: Not defined
|
|
94
|
+
- **Accept**: application/json
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
# **create_brand**
|
|
99
|
+
> BrandsResponse create_brand(account_id, opts)
|
|
100
|
+
|
|
101
|
+
Creates one or more brand profile files for the account.
|
|
102
|
+
|
|
103
|
+
Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
|
|
104
|
+
|
|
105
|
+
### Example
|
|
106
|
+
```ruby
|
|
107
|
+
# load the gem
|
|
108
|
+
require 'docusign_esign'
|
|
109
|
+
|
|
110
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
111
|
+
|
|
112
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
113
|
+
|
|
114
|
+
opts = {
|
|
115
|
+
brand: DocuSign_eSign::Brand.new # Brand |
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
begin
|
|
119
|
+
#Creates one or more brand profile files for the account.
|
|
120
|
+
result = api_instance.create_brand(account_id, opts)
|
|
121
|
+
p result
|
|
122
|
+
rescue DocuSign_eSign::ApiError => e
|
|
123
|
+
puts "Exception when calling AccountsApi->create_brand: #{e}"
|
|
124
|
+
end
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Parameters
|
|
128
|
+
|
|
129
|
+
Name | Type | Description | Notes
|
|
130
|
+
------------- | ------------- | ------------- | -------------
|
|
131
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
132
|
+
**brand** | [**Brand**](Brand.md)| | [optional]
|
|
133
|
+
|
|
134
|
+
### Return type
|
|
135
|
+
|
|
136
|
+
[**BrandsResponse**](BrandsResponse.md)
|
|
137
|
+
|
|
138
|
+
### Authorization
|
|
139
|
+
|
|
140
|
+
No authorization required
|
|
141
|
+
|
|
142
|
+
### HTTP request headers
|
|
143
|
+
|
|
144
|
+
- **Content-Type**: Not defined
|
|
145
|
+
- **Accept**: application/json
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
# **create_e_mortgage_transaction**
|
|
150
|
+
> PostTransactionsResponse create_e_mortgage_transaction(account_id, opts)
|
|
151
|
+
|
|
152
|
+
Starts a new eMortgage Transaction
|
|
153
|
+
|
|
154
|
+
### Example
|
|
155
|
+
```ruby
|
|
156
|
+
# load the gem
|
|
157
|
+
require 'docusign_esign'
|
|
158
|
+
|
|
159
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
160
|
+
|
|
161
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
162
|
+
|
|
163
|
+
opts = {
|
|
164
|
+
post_transactions_request: DocuSign_eSign::PostTransactionsRequest.new # PostTransactionsRequest |
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
begin
|
|
168
|
+
#Starts a new eMortgage Transaction
|
|
169
|
+
result = api_instance.create_e_mortgage_transaction(account_id, opts)
|
|
170
|
+
p result
|
|
171
|
+
rescue DocuSign_eSign::ApiError => e
|
|
172
|
+
puts "Exception when calling AccountsApi->create_e_mortgage_transaction: #{e}"
|
|
173
|
+
end
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Parameters
|
|
177
|
+
|
|
178
|
+
Name | Type | Description | Notes
|
|
179
|
+
------------- | ------------- | ------------- | -------------
|
|
180
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
181
|
+
**post_transactions_request** | [**PostTransactionsRequest**](PostTransactionsRequest.md)| | [optional]
|
|
182
|
+
|
|
183
|
+
### Return type
|
|
184
|
+
|
|
185
|
+
[**PostTransactionsResponse**](PostTransactionsResponse.md)
|
|
186
|
+
|
|
187
|
+
### Authorization
|
|
188
|
+
|
|
189
|
+
No authorization required
|
|
190
|
+
|
|
191
|
+
### HTTP request headers
|
|
192
|
+
|
|
193
|
+
- **Content-Type**: Not defined
|
|
194
|
+
- **Accept**: application/json
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
# **create_permission_profile**
|
|
199
|
+
> PermissionProfile create_permission_profile(account_id, opts)
|
|
200
|
+
|
|
201
|
+
Creates a new permission profile in the specified account.
|
|
202
|
+
|
|
203
|
+
### Example
|
|
204
|
+
```ruby
|
|
205
|
+
# load the gem
|
|
206
|
+
require 'docusign_esign'
|
|
207
|
+
|
|
208
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
209
|
+
|
|
210
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
211
|
+
|
|
212
|
+
opts = {
|
|
213
|
+
include: "include_example", # String |
|
|
214
|
+
permission_profile: DocuSign_eSign::PermissionProfile.new # PermissionProfile |
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
begin
|
|
218
|
+
#Creates a new permission profile in the specified account.
|
|
219
|
+
result = api_instance.create_permission_profile(account_id, opts)
|
|
220
|
+
p result
|
|
221
|
+
rescue DocuSign_eSign::ApiError => e
|
|
222
|
+
puts "Exception when calling AccountsApi->create_permission_profile: #{e}"
|
|
223
|
+
end
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### Parameters
|
|
227
|
+
|
|
228
|
+
Name | Type | Description | Notes
|
|
229
|
+
------------- | ------------- | ------------- | -------------
|
|
230
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
231
|
+
**include** | **String**| | [optional]
|
|
232
|
+
**permission_profile** | [**PermissionProfile**](PermissionProfile.md)| | [optional]
|
|
233
|
+
|
|
234
|
+
### Return type
|
|
235
|
+
|
|
236
|
+
[**PermissionProfile**](PermissionProfile.md)
|
|
237
|
+
|
|
238
|
+
### Authorization
|
|
239
|
+
|
|
240
|
+
No authorization required
|
|
241
|
+
|
|
242
|
+
### HTTP request headers
|
|
243
|
+
|
|
244
|
+
- **Content-Type**: Not defined
|
|
245
|
+
- **Accept**: application/json
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
# **delete**
|
|
250
|
+
> delete(account_id)
|
|
251
|
+
|
|
252
|
+
Deletes the specified account.
|
|
253
|
+
|
|
254
|
+
This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
|
|
255
|
+
|
|
256
|
+
### Example
|
|
257
|
+
```ruby
|
|
258
|
+
# load the gem
|
|
259
|
+
require 'docusign_esign'
|
|
260
|
+
|
|
261
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
262
|
+
|
|
263
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
begin
|
|
267
|
+
#Deletes the specified account.
|
|
268
|
+
api_instance.delete(account_id)
|
|
269
|
+
rescue DocuSign_eSign::ApiError => e
|
|
270
|
+
puts "Exception when calling AccountsApi->delete: #{e}"
|
|
271
|
+
end
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### Parameters
|
|
275
|
+
|
|
276
|
+
Name | Type | Description | Notes
|
|
277
|
+
------------- | ------------- | ------------- | -------------
|
|
278
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
279
|
+
|
|
280
|
+
### Return type
|
|
281
|
+
|
|
282
|
+
nil (empty response body)
|
|
283
|
+
|
|
284
|
+
### Authorization
|
|
285
|
+
|
|
286
|
+
No authorization required
|
|
287
|
+
|
|
288
|
+
### HTTP request headers
|
|
289
|
+
|
|
290
|
+
- **Content-Type**: Not defined
|
|
291
|
+
- **Accept**: application/json
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
# **delete_brand**
|
|
296
|
+
> delete_brand(account_id, brand_id)
|
|
297
|
+
|
|
298
|
+
Removes a brand.
|
|
299
|
+
|
|
300
|
+
### Example
|
|
301
|
+
```ruby
|
|
302
|
+
# load the gem
|
|
303
|
+
require 'docusign_esign'
|
|
304
|
+
|
|
305
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
306
|
+
|
|
307
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
308
|
+
|
|
309
|
+
brand_id = "brand_id_example" # String | The unique identifier of a brand.
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
begin
|
|
313
|
+
#Removes a brand.
|
|
314
|
+
api_instance.delete_brand(account_id, brand_id)
|
|
315
|
+
rescue DocuSign_eSign::ApiError => e
|
|
316
|
+
puts "Exception when calling AccountsApi->delete_brand: #{e}"
|
|
317
|
+
end
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Parameters
|
|
321
|
+
|
|
322
|
+
Name | Type | Description | Notes
|
|
323
|
+
------------- | ------------- | ------------- | -------------
|
|
324
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
325
|
+
**brand_id** | **String**| The unique identifier of a brand. |
|
|
326
|
+
|
|
327
|
+
### Return type
|
|
328
|
+
|
|
329
|
+
nil (empty response body)
|
|
330
|
+
|
|
331
|
+
### Authorization
|
|
332
|
+
|
|
333
|
+
No authorization required
|
|
334
|
+
|
|
335
|
+
### HTTP request headers
|
|
336
|
+
|
|
337
|
+
- **Content-Type**: Not defined
|
|
338
|
+
- **Accept**: application/json
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
# **delete_brand_logo_by_type**
|
|
343
|
+
> delete_brand_logo_by_type(account_id, brand_id, logo_type)
|
|
344
|
+
|
|
345
|
+
Delete one branding logo.
|
|
346
|
+
|
|
347
|
+
### Example
|
|
348
|
+
```ruby
|
|
349
|
+
# load the gem
|
|
350
|
+
require 'docusign_esign'
|
|
351
|
+
|
|
352
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
353
|
+
|
|
354
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
355
|
+
|
|
356
|
+
brand_id = "brand_id_example" # String | The unique identifier of a brand.
|
|
357
|
+
|
|
358
|
+
logo_type = "logo_type_example" # String | One of **Primary**, **Secondary** or **Email**.
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
begin
|
|
362
|
+
#Delete one branding logo.
|
|
363
|
+
api_instance.delete_brand_logo_by_type(account_id, brand_id, logo_type)
|
|
364
|
+
rescue DocuSign_eSign::ApiError => e
|
|
365
|
+
puts "Exception when calling AccountsApi->delete_brand_logo_by_type: #{e}"
|
|
366
|
+
end
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### Parameters
|
|
370
|
+
|
|
371
|
+
Name | Type | Description | Notes
|
|
372
|
+
------------- | ------------- | ------------- | -------------
|
|
373
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
374
|
+
**brand_id** | **String**| The unique identifier of a brand. |
|
|
375
|
+
**logo_type** | **String**| One of **Primary**, **Secondary** or **Email**. |
|
|
376
|
+
|
|
377
|
+
### Return type
|
|
378
|
+
|
|
379
|
+
nil (empty response body)
|
|
380
|
+
|
|
381
|
+
### Authorization
|
|
382
|
+
|
|
383
|
+
No authorization required
|
|
384
|
+
|
|
385
|
+
### HTTP request headers
|
|
386
|
+
|
|
387
|
+
- **Content-Type**: Not defined
|
|
388
|
+
- **Accept**: application/json
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
# **delete_brands**
|
|
393
|
+
> BrandsResponse delete_brands(account_id, opts)
|
|
394
|
+
|
|
395
|
+
Deletes one or more brand profiles.
|
|
396
|
+
|
|
397
|
+
Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** to use this call.
|
|
398
|
+
|
|
399
|
+
### Example
|
|
400
|
+
```ruby
|
|
401
|
+
# load the gem
|
|
402
|
+
require 'docusign_esign'
|
|
403
|
+
|
|
404
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
405
|
+
|
|
406
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
407
|
+
|
|
408
|
+
opts = {
|
|
409
|
+
brands_request: DocuSign_eSign::BrandsRequest.new # BrandsRequest |
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
begin
|
|
413
|
+
#Deletes one or more brand profiles.
|
|
414
|
+
result = api_instance.delete_brands(account_id, opts)
|
|
415
|
+
p result
|
|
416
|
+
rescue DocuSign_eSign::ApiError => e
|
|
417
|
+
puts "Exception when calling AccountsApi->delete_brands: #{e}"
|
|
418
|
+
end
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### Parameters
|
|
422
|
+
|
|
423
|
+
Name | Type | Description | Notes
|
|
424
|
+
------------- | ------------- | ------------- | -------------
|
|
425
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
426
|
+
**brands_request** | [**BrandsRequest**](BrandsRequest.md)| | [optional]
|
|
427
|
+
|
|
428
|
+
### Return type
|
|
429
|
+
|
|
430
|
+
[**BrandsResponse**](BrandsResponse.md)
|
|
431
|
+
|
|
432
|
+
### Authorization
|
|
433
|
+
|
|
434
|
+
No authorization required
|
|
435
|
+
|
|
436
|
+
### HTTP request headers
|
|
437
|
+
|
|
438
|
+
- **Content-Type**: Not defined
|
|
439
|
+
- **Accept**: application/json
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
# **delete_captive_recipient**
|
|
444
|
+
> CaptiveRecipientInformation delete_captive_recipient(account_id, recipient_part, opts)
|
|
445
|
+
|
|
446
|
+
Deletes the signature for one or more captive recipient records.
|
|
447
|
+
|
|
448
|
+
Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.
|
|
449
|
+
|
|
450
|
+
### Example
|
|
451
|
+
```ruby
|
|
452
|
+
# load the gem
|
|
453
|
+
require 'docusign_esign'
|
|
454
|
+
|
|
455
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
456
|
+
|
|
457
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
458
|
+
|
|
459
|
+
recipient_part = "recipient_part_example" # String |
|
|
460
|
+
|
|
461
|
+
opts = {
|
|
462
|
+
captive_recipient_information: DocuSign_eSign::CaptiveRecipientInformation.new # CaptiveRecipientInformation |
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
begin
|
|
466
|
+
#Deletes the signature for one or more captive recipient records.
|
|
467
|
+
result = api_instance.delete_captive_recipient(account_id, recipient_part, opts)
|
|
468
|
+
p result
|
|
469
|
+
rescue DocuSign_eSign::ApiError => e
|
|
470
|
+
puts "Exception when calling AccountsApi->delete_captive_recipient: #{e}"
|
|
471
|
+
end
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
### Parameters
|
|
475
|
+
|
|
476
|
+
Name | Type | Description | Notes
|
|
477
|
+
------------- | ------------- | ------------- | -------------
|
|
478
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
479
|
+
**recipient_part** | **String**| |
|
|
480
|
+
**captive_recipient_information** | [**CaptiveRecipientInformation**](CaptiveRecipientInformation.md)| | [optional]
|
|
481
|
+
|
|
482
|
+
### Return type
|
|
483
|
+
|
|
484
|
+
[**CaptiveRecipientInformation**](CaptiveRecipientInformation.md)
|
|
485
|
+
|
|
486
|
+
### Authorization
|
|
487
|
+
|
|
488
|
+
No authorization required
|
|
489
|
+
|
|
490
|
+
### HTTP request headers
|
|
491
|
+
|
|
492
|
+
- **Content-Type**: Not defined
|
|
493
|
+
- **Accept**: application/json
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
# **delete_e_note_configuration**
|
|
498
|
+
> delete_e_note_configuration(account_id)
|
|
499
|
+
|
|
500
|
+
Deletes configuration information for the eNote eOriginal integration.
|
|
501
|
+
|
|
502
|
+
### Example
|
|
503
|
+
```ruby
|
|
504
|
+
# load the gem
|
|
505
|
+
require 'docusign_esign'
|
|
506
|
+
|
|
507
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
508
|
+
|
|
509
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
begin
|
|
513
|
+
#Deletes configuration information for the eNote eOriginal integration.
|
|
514
|
+
api_instance.delete_e_note_configuration(account_id)
|
|
515
|
+
rescue DocuSign_eSign::ApiError => e
|
|
516
|
+
puts "Exception when calling AccountsApi->delete_e_note_configuration: #{e}"
|
|
517
|
+
end
|
|
518
|
+
```
|
|
519
|
+
|
|
520
|
+
### Parameters
|
|
521
|
+
|
|
522
|
+
Name | Type | Description | Notes
|
|
523
|
+
------------- | ------------- | ------------- | -------------
|
|
524
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
525
|
+
|
|
526
|
+
### Return type
|
|
527
|
+
|
|
528
|
+
nil (empty response body)
|
|
529
|
+
|
|
530
|
+
### Authorization
|
|
531
|
+
|
|
532
|
+
No authorization required
|
|
533
|
+
|
|
534
|
+
### HTTP request headers
|
|
535
|
+
|
|
536
|
+
- **Content-Type**: Not defined
|
|
537
|
+
- **Accept**: application/json
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
# **delete_permission_profile**
|
|
542
|
+
> delete_permission_profile(account_id, permission_profile_id)
|
|
543
|
+
|
|
544
|
+
Deletes a permissions profile within the specified account.
|
|
545
|
+
|
|
546
|
+
### Example
|
|
547
|
+
```ruby
|
|
548
|
+
# load the gem
|
|
549
|
+
require 'docusign_esign'
|
|
550
|
+
|
|
551
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
552
|
+
|
|
553
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
554
|
+
|
|
555
|
+
permission_profile_id = "permission_profile_id_example" # String |
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
begin
|
|
559
|
+
#Deletes a permissions profile within the specified account.
|
|
560
|
+
api_instance.delete_permission_profile(account_id, permission_profile_id)
|
|
561
|
+
rescue DocuSign_eSign::ApiError => e
|
|
562
|
+
puts "Exception when calling AccountsApi->delete_permission_profile: #{e}"
|
|
563
|
+
end
|
|
564
|
+
```
|
|
565
|
+
|
|
566
|
+
### Parameters
|
|
567
|
+
|
|
568
|
+
Name | Type | Description | Notes
|
|
569
|
+
------------- | ------------- | ------------- | -------------
|
|
570
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
571
|
+
**permission_profile_id** | **String**| |
|
|
572
|
+
|
|
573
|
+
### Return type
|
|
574
|
+
|
|
575
|
+
nil (empty response body)
|
|
576
|
+
|
|
577
|
+
### Authorization
|
|
578
|
+
|
|
579
|
+
No authorization required
|
|
580
|
+
|
|
581
|
+
### HTTP request headers
|
|
582
|
+
|
|
583
|
+
- **Content-Type**: Not defined
|
|
584
|
+
- **Accept**: application/json
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
# **get_account_information**
|
|
589
|
+
> AccountInformation get_account_information(account_id, opts)
|
|
590
|
+
|
|
591
|
+
Retrieves the account information for the specified account.
|
|
592
|
+
|
|
593
|
+
Retrieves the account information for the specified account. **Response** The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.
|
|
594
|
+
|
|
595
|
+
### Example
|
|
596
|
+
```ruby
|
|
597
|
+
# load the gem
|
|
598
|
+
require 'docusign_esign'
|
|
599
|
+
|
|
600
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
601
|
+
|
|
602
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
603
|
+
|
|
604
|
+
opts = {
|
|
605
|
+
include_account_settings: "include_account_settings_example" # String | When set to **true**, includes the account settings for the account in the response.
|
|
606
|
+
}
|
|
607
|
+
|
|
608
|
+
begin
|
|
609
|
+
#Retrieves the account information for the specified account.
|
|
610
|
+
result = api_instance.get_account_information(account_id, opts)
|
|
611
|
+
p result
|
|
612
|
+
rescue DocuSign_eSign::ApiError => e
|
|
613
|
+
puts "Exception when calling AccountsApi->get_account_information: #{e}"
|
|
614
|
+
end
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
### Parameters
|
|
618
|
+
|
|
619
|
+
Name | Type | Description | Notes
|
|
620
|
+
------------- | ------------- | ------------- | -------------
|
|
621
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
622
|
+
**include_account_settings** | **String**| When set to **true**, includes the account settings for the account in the response. | [optional]
|
|
623
|
+
|
|
624
|
+
### Return type
|
|
625
|
+
|
|
626
|
+
[**AccountInformation**](AccountInformation.md)
|
|
627
|
+
|
|
628
|
+
### Authorization
|
|
629
|
+
|
|
630
|
+
No authorization required
|
|
631
|
+
|
|
632
|
+
### HTTP request headers
|
|
633
|
+
|
|
634
|
+
- **Content-Type**: Not defined
|
|
635
|
+
- **Accept**: application/json
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
# **get_account_tab_settings**
|
|
640
|
+
> TabAccountSettings get_account_tab_settings(account_id)
|
|
641
|
+
|
|
642
|
+
Returns tab settings list for specified account
|
|
643
|
+
|
|
644
|
+
### Example
|
|
645
|
+
```ruby
|
|
646
|
+
# load the gem
|
|
647
|
+
require 'docusign_esign'
|
|
648
|
+
|
|
649
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
650
|
+
|
|
651
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
begin
|
|
655
|
+
#Returns tab settings list for specified account
|
|
656
|
+
result = api_instance.get_account_tab_settings(account_id)
|
|
657
|
+
p result
|
|
658
|
+
rescue DocuSign_eSign::ApiError => e
|
|
659
|
+
puts "Exception when calling AccountsApi->get_account_tab_settings: #{e}"
|
|
660
|
+
end
|
|
661
|
+
```
|
|
662
|
+
|
|
663
|
+
### Parameters
|
|
664
|
+
|
|
665
|
+
Name | Type | Description | Notes
|
|
666
|
+
------------- | ------------- | ------------- | -------------
|
|
667
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
668
|
+
|
|
669
|
+
### Return type
|
|
670
|
+
|
|
671
|
+
[**TabAccountSettings**](TabAccountSettings.md)
|
|
672
|
+
|
|
673
|
+
### Authorization
|
|
674
|
+
|
|
675
|
+
No authorization required
|
|
676
|
+
|
|
677
|
+
### HTTP request headers
|
|
678
|
+
|
|
679
|
+
- **Content-Type**: Not defined
|
|
680
|
+
- **Accept**: application/json
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
# **get_billing_charges**
|
|
685
|
+
> BillingChargeResponse get_billing_charges(account_id, opts)
|
|
686
|
+
|
|
687
|
+
Gets list of recurring and usage charges for the account.
|
|
688
|
+
|
|
689
|
+
Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator
|
|
690
|
+
|
|
691
|
+
### Example
|
|
692
|
+
```ruby
|
|
693
|
+
# load the gem
|
|
694
|
+
require 'docusign_esign'
|
|
695
|
+
|
|
696
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
697
|
+
|
|
698
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
699
|
+
|
|
700
|
+
opts = {
|
|
701
|
+
include_charges: "include_charges_example" # String | Specifies which billing charges to return. Valid values are: * envelopes * seats
|
|
702
|
+
}
|
|
703
|
+
|
|
704
|
+
begin
|
|
705
|
+
#Gets list of recurring and usage charges for the account.
|
|
706
|
+
result = api_instance.get_billing_charges(account_id, opts)
|
|
707
|
+
p result
|
|
708
|
+
rescue DocuSign_eSign::ApiError => e
|
|
709
|
+
puts "Exception when calling AccountsApi->get_billing_charges: #{e}"
|
|
710
|
+
end
|
|
711
|
+
```
|
|
712
|
+
|
|
713
|
+
### Parameters
|
|
714
|
+
|
|
715
|
+
Name | Type | Description | Notes
|
|
716
|
+
------------- | ------------- | ------------- | -------------
|
|
717
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
718
|
+
**include_charges** | **String**| Specifies which billing charges to return. Valid values are: * envelopes * seats | [optional]
|
|
719
|
+
|
|
720
|
+
### Return type
|
|
721
|
+
|
|
722
|
+
[**BillingChargeResponse**](BillingChargeResponse.md)
|
|
723
|
+
|
|
724
|
+
### Authorization
|
|
725
|
+
|
|
726
|
+
No authorization required
|
|
727
|
+
|
|
728
|
+
### HTTP request headers
|
|
729
|
+
|
|
730
|
+
- **Content-Type**: Not defined
|
|
731
|
+
- **Accept**: application/json
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
# **get_brand**
|
|
736
|
+
> Brand get_brand(account_id, brand_id, opts)
|
|
737
|
+
|
|
738
|
+
Get information for a specific brand.
|
|
739
|
+
|
|
740
|
+
### Example
|
|
741
|
+
```ruby
|
|
742
|
+
# load the gem
|
|
743
|
+
require 'docusign_esign'
|
|
744
|
+
|
|
745
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
746
|
+
|
|
747
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
748
|
+
|
|
749
|
+
brand_id = "brand_id_example" # String | The unique identifier of a brand.
|
|
750
|
+
|
|
751
|
+
opts = {
|
|
752
|
+
include_external_references: "include_external_references_example", # String |
|
|
753
|
+
include_logos: "include_logos_example" # String |
|
|
754
|
+
}
|
|
755
|
+
|
|
756
|
+
begin
|
|
757
|
+
#Get information for a specific brand.
|
|
758
|
+
result = api_instance.get_brand(account_id, brand_id, opts)
|
|
759
|
+
p result
|
|
760
|
+
rescue DocuSign_eSign::ApiError => e
|
|
761
|
+
puts "Exception when calling AccountsApi->get_brand: #{e}"
|
|
762
|
+
end
|
|
763
|
+
```
|
|
764
|
+
|
|
765
|
+
### Parameters
|
|
766
|
+
|
|
767
|
+
Name | Type | Description | Notes
|
|
768
|
+
------------- | ------------- | ------------- | -------------
|
|
769
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
770
|
+
**brand_id** | **String**| The unique identifier of a brand. |
|
|
771
|
+
**include_external_references** | **String**| | [optional]
|
|
772
|
+
**include_logos** | **String**| | [optional]
|
|
773
|
+
|
|
774
|
+
### Return type
|
|
775
|
+
|
|
776
|
+
[**Brand**](Brand.md)
|
|
777
|
+
|
|
778
|
+
### Authorization
|
|
779
|
+
|
|
780
|
+
No authorization required
|
|
781
|
+
|
|
782
|
+
### HTTP request headers
|
|
783
|
+
|
|
784
|
+
- **Content-Type**: Not defined
|
|
785
|
+
- **Accept**: application/json
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
# **get_brand_logo_by_type**
|
|
790
|
+
> get_brand_logo_by_type(account_id, brand_id, logo_type)
|
|
791
|
+
|
|
792
|
+
Obtains the specified image for a brand.
|
|
793
|
+
|
|
794
|
+
### Example
|
|
795
|
+
```ruby
|
|
796
|
+
# load the gem
|
|
797
|
+
require 'docusign_esign'
|
|
798
|
+
|
|
799
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
800
|
+
|
|
801
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
802
|
+
|
|
803
|
+
brand_id = "brand_id_example" # String | The unique identifier of a brand.
|
|
804
|
+
|
|
805
|
+
logo_type = "logo_type_example" # String | One of **Primary**, **Secondary** or **Email**.
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
begin
|
|
809
|
+
#Obtains the specified image for a brand.
|
|
810
|
+
api_instance.get_brand_logo_by_type(account_id, brand_id, logo_type)
|
|
811
|
+
rescue DocuSign_eSign::ApiError => e
|
|
812
|
+
puts "Exception when calling AccountsApi->get_brand_logo_by_type: #{e}"
|
|
813
|
+
end
|
|
814
|
+
```
|
|
815
|
+
|
|
816
|
+
### Parameters
|
|
817
|
+
|
|
818
|
+
Name | Type | Description | Notes
|
|
819
|
+
------------- | ------------- | ------------- | -------------
|
|
820
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
821
|
+
**brand_id** | **String**| The unique identifier of a brand. |
|
|
822
|
+
**logo_type** | **String**| One of **Primary**, **Secondary** or **Email**. |
|
|
823
|
+
|
|
824
|
+
### Return type
|
|
825
|
+
|
|
826
|
+
nil (empty response body)
|
|
827
|
+
|
|
828
|
+
### Authorization
|
|
829
|
+
|
|
830
|
+
No authorization required
|
|
831
|
+
|
|
832
|
+
### HTTP request headers
|
|
833
|
+
|
|
834
|
+
- **Content-Type**: Not defined
|
|
835
|
+
- **Accept**: application/json
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
# **get_brand_resources**
|
|
840
|
+
> BrandResourcesList get_brand_resources(account_id, brand_id)
|
|
841
|
+
|
|
842
|
+
Returns the specified account's list of branding resources (metadata).
|
|
843
|
+
|
|
844
|
+
### Example
|
|
845
|
+
```ruby
|
|
846
|
+
# load the gem
|
|
847
|
+
require 'docusign_esign'
|
|
848
|
+
|
|
849
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
850
|
+
|
|
851
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
852
|
+
|
|
853
|
+
brand_id = "brand_id_example" # String | The unique identifier of a brand.
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
begin
|
|
857
|
+
#Returns the specified account's list of branding resources (metadata).
|
|
858
|
+
result = api_instance.get_brand_resources(account_id, brand_id)
|
|
859
|
+
p result
|
|
860
|
+
rescue DocuSign_eSign::ApiError => e
|
|
861
|
+
puts "Exception when calling AccountsApi->get_brand_resources: #{e}"
|
|
862
|
+
end
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
### Parameters
|
|
866
|
+
|
|
867
|
+
Name | Type | Description | Notes
|
|
868
|
+
------------- | ------------- | ------------- | -------------
|
|
869
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
870
|
+
**brand_id** | **String**| The unique identifier of a brand. |
|
|
871
|
+
|
|
872
|
+
### Return type
|
|
873
|
+
|
|
874
|
+
[**BrandResourcesList**](BrandResourcesList.md)
|
|
875
|
+
|
|
876
|
+
### Authorization
|
|
877
|
+
|
|
878
|
+
No authorization required
|
|
879
|
+
|
|
880
|
+
### HTTP request headers
|
|
881
|
+
|
|
882
|
+
- **Content-Type**: Not defined
|
|
883
|
+
- **Accept**: application/json
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
# **get_brand_resources_by_content_type**
|
|
888
|
+
> get_brand_resources_by_content_type(account_id, brand_id, resource_content_type, opts)
|
|
889
|
+
|
|
890
|
+
Returns the specified branding resource file.
|
|
891
|
+
|
|
892
|
+
### Example
|
|
893
|
+
```ruby
|
|
894
|
+
# load the gem
|
|
895
|
+
require 'docusign_esign'
|
|
896
|
+
|
|
897
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
898
|
+
|
|
899
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
900
|
+
|
|
901
|
+
brand_id = "brand_id_example" # String | The unique identifier of a brand.
|
|
902
|
+
|
|
903
|
+
resource_content_type = "resource_content_type_example" # String |
|
|
904
|
+
|
|
905
|
+
opts = {
|
|
906
|
+
langcode: "langcode_example", # String |
|
|
907
|
+
return_master: "return_master_example" # String |
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
begin
|
|
911
|
+
#Returns the specified branding resource file.
|
|
912
|
+
api_instance.get_brand_resources_by_content_type(account_id, brand_id, resource_content_type, opts)
|
|
913
|
+
rescue DocuSign_eSign::ApiError => e
|
|
914
|
+
puts "Exception when calling AccountsApi->get_brand_resources_by_content_type: #{e}"
|
|
915
|
+
end
|
|
916
|
+
```
|
|
917
|
+
|
|
918
|
+
### Parameters
|
|
919
|
+
|
|
920
|
+
Name | Type | Description | Notes
|
|
921
|
+
------------- | ------------- | ------------- | -------------
|
|
922
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
923
|
+
**brand_id** | **String**| The unique identifier of a brand. |
|
|
924
|
+
**resource_content_type** | **String**| |
|
|
925
|
+
**langcode** | **String**| | [optional]
|
|
926
|
+
**return_master** | **String**| | [optional]
|
|
927
|
+
|
|
928
|
+
### Return type
|
|
929
|
+
|
|
930
|
+
nil (empty response body)
|
|
931
|
+
|
|
932
|
+
### Authorization
|
|
933
|
+
|
|
934
|
+
No authorization required
|
|
935
|
+
|
|
936
|
+
### HTTP request headers
|
|
937
|
+
|
|
938
|
+
- **Content-Type**: Not defined
|
|
939
|
+
- **Accept**: application/json
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
# **get_consumer_disclosure**
|
|
944
|
+
> ConsumerDisclosure get_consumer_disclosure(account_id, lang_code)
|
|
945
|
+
|
|
946
|
+
Gets the Electronic Record and Signature Disclosure.
|
|
947
|
+
|
|
948
|
+
Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
|
|
949
|
+
|
|
950
|
+
### Example
|
|
951
|
+
```ruby
|
|
952
|
+
# load the gem
|
|
953
|
+
require 'docusign_esign'
|
|
954
|
+
|
|
955
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
956
|
+
|
|
957
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
958
|
+
|
|
959
|
+
lang_code = "lang_code_example" # String | The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
begin
|
|
963
|
+
#Gets the Electronic Record and Signature Disclosure.
|
|
964
|
+
result = api_instance.get_consumer_disclosure(account_id, lang_code)
|
|
965
|
+
p result
|
|
966
|
+
rescue DocuSign_eSign::ApiError => e
|
|
967
|
+
puts "Exception when calling AccountsApi->get_consumer_disclosure: #{e}"
|
|
968
|
+
end
|
|
969
|
+
```
|
|
970
|
+
|
|
971
|
+
### Parameters
|
|
972
|
+
|
|
973
|
+
Name | Type | Description | Notes
|
|
974
|
+
------------- | ------------- | ------------- | -------------
|
|
975
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
976
|
+
**lang_code** | **String**| The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. |
|
|
977
|
+
|
|
978
|
+
### Return type
|
|
979
|
+
|
|
980
|
+
[**ConsumerDisclosure**](ConsumerDisclosure.md)
|
|
981
|
+
|
|
982
|
+
### Authorization
|
|
983
|
+
|
|
984
|
+
No authorization required
|
|
985
|
+
|
|
986
|
+
### HTTP request headers
|
|
987
|
+
|
|
988
|
+
- **Content-Type**: Not defined
|
|
989
|
+
- **Accept**: application/json
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
# **get_consumer_disclosure_default**
|
|
994
|
+
> ConsumerDisclosure get_consumer_disclosure_default(account_id, opts)
|
|
995
|
+
|
|
996
|
+
Gets the Electronic Record and Signature Disclosure for the account.
|
|
997
|
+
|
|
998
|
+
Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
|
|
999
|
+
|
|
1000
|
+
### Example
|
|
1001
|
+
```ruby
|
|
1002
|
+
# load the gem
|
|
1003
|
+
require 'docusign_esign'
|
|
1004
|
+
|
|
1005
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1006
|
+
|
|
1007
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1008
|
+
|
|
1009
|
+
opts = {
|
|
1010
|
+
lang_code: "lang_code_example" # String | Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). Additionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
|
1011
|
+
}
|
|
1012
|
+
|
|
1013
|
+
begin
|
|
1014
|
+
#Gets the Electronic Record and Signature Disclosure for the account.
|
|
1015
|
+
result = api_instance.get_consumer_disclosure_default(account_id, opts)
|
|
1016
|
+
p result
|
|
1017
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1018
|
+
puts "Exception when calling AccountsApi->get_consumer_disclosure_default: #{e}"
|
|
1019
|
+
end
|
|
1020
|
+
```
|
|
1021
|
+
|
|
1022
|
+
### Parameters
|
|
1023
|
+
|
|
1024
|
+
Name | Type | Description | Notes
|
|
1025
|
+
------------- | ------------- | ------------- | -------------
|
|
1026
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1027
|
+
**lang_code** | **String**| Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). Additionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language. | [optional]
|
|
1028
|
+
|
|
1029
|
+
### Return type
|
|
1030
|
+
|
|
1031
|
+
[**ConsumerDisclosure**](ConsumerDisclosure.md)
|
|
1032
|
+
|
|
1033
|
+
### Authorization
|
|
1034
|
+
|
|
1035
|
+
No authorization required
|
|
1036
|
+
|
|
1037
|
+
### HTTP request headers
|
|
1038
|
+
|
|
1039
|
+
- **Content-Type**: Not defined
|
|
1040
|
+
- **Accept**: application/json
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
# **get_e_note_configuration**
|
|
1045
|
+
> ENoteConfiguration get_e_note_configuration(account_id)
|
|
1046
|
+
|
|
1047
|
+
Returns the configuration information for the eNote eOriginal integration.
|
|
1048
|
+
|
|
1049
|
+
### Example
|
|
1050
|
+
```ruby
|
|
1051
|
+
# load the gem
|
|
1052
|
+
require 'docusign_esign'
|
|
1053
|
+
|
|
1054
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1055
|
+
|
|
1056
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
begin
|
|
1060
|
+
#Returns the configuration information for the eNote eOriginal integration.
|
|
1061
|
+
result = api_instance.get_e_note_configuration(account_id)
|
|
1062
|
+
p result
|
|
1063
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1064
|
+
puts "Exception when calling AccountsApi->get_e_note_configuration: #{e}"
|
|
1065
|
+
end
|
|
1066
|
+
```
|
|
1067
|
+
|
|
1068
|
+
### Parameters
|
|
1069
|
+
|
|
1070
|
+
Name | Type | Description | Notes
|
|
1071
|
+
------------- | ------------- | ------------- | -------------
|
|
1072
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1073
|
+
|
|
1074
|
+
### Return type
|
|
1075
|
+
|
|
1076
|
+
[**ENoteConfiguration**](ENoteConfiguration.md)
|
|
1077
|
+
|
|
1078
|
+
### Authorization
|
|
1079
|
+
|
|
1080
|
+
No authorization required
|
|
1081
|
+
|
|
1082
|
+
### HTTP request headers
|
|
1083
|
+
|
|
1084
|
+
- **Content-Type**: Not defined
|
|
1085
|
+
- **Accept**: application/json
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
# **get_permission_profile**
|
|
1090
|
+
> PermissionProfile get_permission_profile(account_id, permission_profile_id, opts)
|
|
1091
|
+
|
|
1092
|
+
Returns a permissions profile in the specified account.
|
|
1093
|
+
|
|
1094
|
+
### Example
|
|
1095
|
+
```ruby
|
|
1096
|
+
# load the gem
|
|
1097
|
+
require 'docusign_esign'
|
|
1098
|
+
|
|
1099
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1100
|
+
|
|
1101
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1102
|
+
|
|
1103
|
+
permission_profile_id = "permission_profile_id_example" # String |
|
|
1104
|
+
|
|
1105
|
+
opts = {
|
|
1106
|
+
include: "include_example" # String |
|
|
1107
|
+
}
|
|
1108
|
+
|
|
1109
|
+
begin
|
|
1110
|
+
#Returns a permissions profile in the specified account.
|
|
1111
|
+
result = api_instance.get_permission_profile(account_id, permission_profile_id, opts)
|
|
1112
|
+
p result
|
|
1113
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1114
|
+
puts "Exception when calling AccountsApi->get_permission_profile: #{e}"
|
|
1115
|
+
end
|
|
1116
|
+
```
|
|
1117
|
+
|
|
1118
|
+
### Parameters
|
|
1119
|
+
|
|
1120
|
+
Name | Type | Description | Notes
|
|
1121
|
+
------------- | ------------- | ------------- | -------------
|
|
1122
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1123
|
+
**permission_profile_id** | **String**| |
|
|
1124
|
+
**include** | **String**| | [optional]
|
|
1125
|
+
|
|
1126
|
+
### Return type
|
|
1127
|
+
|
|
1128
|
+
[**PermissionProfile**](PermissionProfile.md)
|
|
1129
|
+
|
|
1130
|
+
### Authorization
|
|
1131
|
+
|
|
1132
|
+
No authorization required
|
|
1133
|
+
|
|
1134
|
+
### HTTP request headers
|
|
1135
|
+
|
|
1136
|
+
- **Content-Type**: Not defined
|
|
1137
|
+
- **Accept**: application/json
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
# **get_provisioning**
|
|
1142
|
+
> ProvisioningInformation get_provisioning
|
|
1143
|
+
|
|
1144
|
+
Retrieves the account provisioning information for the account.
|
|
1145
|
+
|
|
1146
|
+
Retrieves the account provisioning information for the account.
|
|
1147
|
+
|
|
1148
|
+
### Example
|
|
1149
|
+
```ruby
|
|
1150
|
+
# load the gem
|
|
1151
|
+
require 'docusign_esign'
|
|
1152
|
+
|
|
1153
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1154
|
+
|
|
1155
|
+
begin
|
|
1156
|
+
#Retrieves the account provisioning information for the account.
|
|
1157
|
+
result = api_instance.get_provisioning
|
|
1158
|
+
p result
|
|
1159
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1160
|
+
puts "Exception when calling AccountsApi->get_provisioning: #{e}"
|
|
1161
|
+
end
|
|
1162
|
+
```
|
|
1163
|
+
|
|
1164
|
+
### Parameters
|
|
1165
|
+
This endpoint does not need any parameter.
|
|
1166
|
+
|
|
1167
|
+
### Return type
|
|
1168
|
+
|
|
1169
|
+
[**ProvisioningInformation**](ProvisioningInformation.md)
|
|
1170
|
+
|
|
1171
|
+
### Authorization
|
|
1172
|
+
|
|
1173
|
+
No authorization required
|
|
1174
|
+
|
|
1175
|
+
### HTTP request headers
|
|
1176
|
+
|
|
1177
|
+
- **Content-Type**: Not defined
|
|
1178
|
+
- **Accept**: application/json
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
# **list_brands**
|
|
1183
|
+
> BrandsResponse list_brands(account_id, opts)
|
|
1184
|
+
|
|
1185
|
+
Gets a list of brand profiles.
|
|
1186
|
+
|
|
1187
|
+
Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call.
|
|
1188
|
+
|
|
1189
|
+
### Example
|
|
1190
|
+
```ruby
|
|
1191
|
+
# load the gem
|
|
1192
|
+
require 'docusign_esign'
|
|
1193
|
+
|
|
1194
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1195
|
+
|
|
1196
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1197
|
+
|
|
1198
|
+
opts = {
|
|
1199
|
+
exclude_distributor_brand: "exclude_distributor_brand_example", # String | When set to **true**, excludes distributor brand information from the response set.
|
|
1200
|
+
include_logos: "include_logos_example" # String | When set to **true**, returns the logos associated with the brand.
|
|
1201
|
+
}
|
|
1202
|
+
|
|
1203
|
+
begin
|
|
1204
|
+
#Gets a list of brand profiles.
|
|
1205
|
+
result = api_instance.list_brands(account_id, opts)
|
|
1206
|
+
p result
|
|
1207
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1208
|
+
puts "Exception when calling AccountsApi->list_brands: #{e}"
|
|
1209
|
+
end
|
|
1210
|
+
```
|
|
1211
|
+
|
|
1212
|
+
### Parameters
|
|
1213
|
+
|
|
1214
|
+
Name | Type | Description | Notes
|
|
1215
|
+
------------- | ------------- | ------------- | -------------
|
|
1216
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1217
|
+
**exclude_distributor_brand** | **String**| When set to **true**, excludes distributor brand information from the response set. | [optional]
|
|
1218
|
+
**include_logos** | **String**| When set to **true**, returns the logos associated with the brand. | [optional]
|
|
1219
|
+
|
|
1220
|
+
### Return type
|
|
1221
|
+
|
|
1222
|
+
[**BrandsResponse**](BrandsResponse.md)
|
|
1223
|
+
|
|
1224
|
+
### Authorization
|
|
1225
|
+
|
|
1226
|
+
No authorization required
|
|
1227
|
+
|
|
1228
|
+
### HTTP request headers
|
|
1229
|
+
|
|
1230
|
+
- **Content-Type**: Not defined
|
|
1231
|
+
- **Accept**: application/json
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
# **list_custom_fields**
|
|
1236
|
+
> CustomFields list_custom_fields(account_id)
|
|
1237
|
+
|
|
1238
|
+
Gets a list of custom fields associated with the account.
|
|
1239
|
+
|
|
1240
|
+
Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide.
|
|
1241
|
+
|
|
1242
|
+
### Example
|
|
1243
|
+
```ruby
|
|
1244
|
+
# load the gem
|
|
1245
|
+
require 'docusign_esign'
|
|
1246
|
+
|
|
1247
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1248
|
+
|
|
1249
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
begin
|
|
1253
|
+
#Gets a list of custom fields associated with the account.
|
|
1254
|
+
result = api_instance.list_custom_fields(account_id)
|
|
1255
|
+
p result
|
|
1256
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1257
|
+
puts "Exception when calling AccountsApi->list_custom_fields: #{e}"
|
|
1258
|
+
end
|
|
1259
|
+
```
|
|
1260
|
+
|
|
1261
|
+
### Parameters
|
|
1262
|
+
|
|
1263
|
+
Name | Type | Description | Notes
|
|
1264
|
+
------------- | ------------- | ------------- | -------------
|
|
1265
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1266
|
+
|
|
1267
|
+
### Return type
|
|
1268
|
+
|
|
1269
|
+
[**CustomFields**](CustomFields.md)
|
|
1270
|
+
|
|
1271
|
+
### Authorization
|
|
1272
|
+
|
|
1273
|
+
No authorization required
|
|
1274
|
+
|
|
1275
|
+
### HTTP request headers
|
|
1276
|
+
|
|
1277
|
+
- **Content-Type**: Not defined
|
|
1278
|
+
- **Accept**: application/json
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
# **list_permissions**
|
|
1283
|
+
> PermissionProfileInformation list_permissions(account_id, opts)
|
|
1284
|
+
|
|
1285
|
+
Gets a list of permission profiles.
|
|
1286
|
+
|
|
1287
|
+
Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console.
|
|
1288
|
+
|
|
1289
|
+
### Example
|
|
1290
|
+
```ruby
|
|
1291
|
+
# load the gem
|
|
1292
|
+
require 'docusign_esign'
|
|
1293
|
+
|
|
1294
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1295
|
+
|
|
1296
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1297
|
+
|
|
1298
|
+
opts = {
|
|
1299
|
+
include: "include_example" # String |
|
|
1300
|
+
}
|
|
1301
|
+
|
|
1302
|
+
begin
|
|
1303
|
+
#Gets a list of permission profiles.
|
|
1304
|
+
result = api_instance.list_permissions(account_id, opts)
|
|
1305
|
+
p result
|
|
1306
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1307
|
+
puts "Exception when calling AccountsApi->list_permissions: #{e}"
|
|
1308
|
+
end
|
|
1309
|
+
```
|
|
1310
|
+
|
|
1311
|
+
### Parameters
|
|
1312
|
+
|
|
1313
|
+
Name | Type | Description | Notes
|
|
1314
|
+
------------- | ------------- | ------------- | -------------
|
|
1315
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1316
|
+
**include** | **String**| | [optional]
|
|
1317
|
+
|
|
1318
|
+
### Return type
|
|
1319
|
+
|
|
1320
|
+
[**PermissionProfileInformation**](PermissionProfileInformation.md)
|
|
1321
|
+
|
|
1322
|
+
### Authorization
|
|
1323
|
+
|
|
1324
|
+
No authorization required
|
|
1325
|
+
|
|
1326
|
+
### HTTP request headers
|
|
1327
|
+
|
|
1328
|
+
- **Content-Type**: Not defined
|
|
1329
|
+
- **Accept**: application/json
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
# **list_recipient_names_by_email**
|
|
1334
|
+
> RecipientNamesResponse list_recipient_names_by_email(account_id, opts)
|
|
1335
|
+
|
|
1336
|
+
Gets recipient names associated with an email address.
|
|
1337
|
+
|
|
1338
|
+
Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.
|
|
1339
|
+
|
|
1340
|
+
### Example
|
|
1341
|
+
```ruby
|
|
1342
|
+
# load the gem
|
|
1343
|
+
require 'docusign_esign'
|
|
1344
|
+
|
|
1345
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1346
|
+
|
|
1347
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1348
|
+
|
|
1349
|
+
opts = {
|
|
1350
|
+
email: "email_example" # String | The email address for the user
|
|
1351
|
+
}
|
|
1352
|
+
|
|
1353
|
+
begin
|
|
1354
|
+
#Gets recipient names associated with an email address.
|
|
1355
|
+
result = api_instance.list_recipient_names_by_email(account_id, opts)
|
|
1356
|
+
p result
|
|
1357
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1358
|
+
puts "Exception when calling AccountsApi->list_recipient_names_by_email: #{e}"
|
|
1359
|
+
end
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
### Parameters
|
|
1363
|
+
|
|
1364
|
+
Name | Type | Description | Notes
|
|
1365
|
+
------------- | ------------- | ------------- | -------------
|
|
1366
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1367
|
+
**email** | **String**| The email address for the user | [optional]
|
|
1368
|
+
|
|
1369
|
+
### Return type
|
|
1370
|
+
|
|
1371
|
+
[**RecipientNamesResponse**](RecipientNamesResponse.md)
|
|
1372
|
+
|
|
1373
|
+
### Authorization
|
|
1374
|
+
|
|
1375
|
+
No authorization required
|
|
1376
|
+
|
|
1377
|
+
### HTTP request headers
|
|
1378
|
+
|
|
1379
|
+
- **Content-Type**: Not defined
|
|
1380
|
+
- **Accept**: application/json
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
# **list_settings**
|
|
1385
|
+
> AccountSettingsInformation list_settings(account_id)
|
|
1386
|
+
|
|
1387
|
+
Gets account settings information.
|
|
1388
|
+
|
|
1389
|
+
Retrieves the account settings information for the specified account.
|
|
1390
|
+
|
|
1391
|
+
### Example
|
|
1392
|
+
```ruby
|
|
1393
|
+
# load the gem
|
|
1394
|
+
require 'docusign_esign'
|
|
1395
|
+
|
|
1396
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1397
|
+
|
|
1398
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
begin
|
|
1402
|
+
#Gets account settings information.
|
|
1403
|
+
result = api_instance.list_settings(account_id)
|
|
1404
|
+
p result
|
|
1405
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1406
|
+
puts "Exception when calling AccountsApi->list_settings: #{e}"
|
|
1407
|
+
end
|
|
1408
|
+
```
|
|
1409
|
+
|
|
1410
|
+
### Parameters
|
|
1411
|
+
|
|
1412
|
+
Name | Type | Description | Notes
|
|
1413
|
+
------------- | ------------- | ------------- | -------------
|
|
1414
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1415
|
+
|
|
1416
|
+
### Return type
|
|
1417
|
+
|
|
1418
|
+
[**AccountSettingsInformation**](AccountSettingsInformation.md)
|
|
1419
|
+
|
|
1420
|
+
### Authorization
|
|
1421
|
+
|
|
1422
|
+
No authorization required
|
|
1423
|
+
|
|
1424
|
+
### HTTP request headers
|
|
1425
|
+
|
|
1426
|
+
- **Content-Type**: Not defined
|
|
1427
|
+
- **Accept**: application/json
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
# **list_shared_access**
|
|
1432
|
+
> AccountSharedAccess list_shared_access(account_id, opts)
|
|
1433
|
+
|
|
1434
|
+
Reserved: Gets the shared item status for one or more users.
|
|
1435
|
+
|
|
1436
|
+
Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from.
|
|
1437
|
+
|
|
1438
|
+
### Example
|
|
1439
|
+
```ruby
|
|
1440
|
+
# load the gem
|
|
1441
|
+
require 'docusign_esign'
|
|
1442
|
+
|
|
1443
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1444
|
+
|
|
1445
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1446
|
+
|
|
1447
|
+
opts = {
|
|
1448
|
+
count: "count_example", # String | Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
|
|
1449
|
+
envelopes_not_shared_user_status: "envelopes_not_shared_user_status_example", # String |
|
|
1450
|
+
folder_ids: "folder_ids_example", # String |
|
|
1451
|
+
item_type: "item_type_example", # String | Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users.
|
|
1452
|
+
search_text: "search_text_example", # String | This can be used to filter user names in the response. The wild-card ‘*’ (asterisk) can be used around the string.
|
|
1453
|
+
shared: "shared_example", # String | Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user
|
|
1454
|
+
start_position: "start_position_example", # String | If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0.
|
|
1455
|
+
user_ids: "user_ids_example" # String | A comma separated list of userIds for whom the shared item information is being requested.
|
|
1456
|
+
}
|
|
1457
|
+
|
|
1458
|
+
begin
|
|
1459
|
+
#Reserved: Gets the shared item status for one or more users.
|
|
1460
|
+
result = api_instance.list_shared_access(account_id, opts)
|
|
1461
|
+
p result
|
|
1462
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1463
|
+
puts "Exception when calling AccountsApi->list_shared_access: #{e}"
|
|
1464
|
+
end
|
|
1465
|
+
```
|
|
1466
|
+
|
|
1467
|
+
### Parameters
|
|
1468
|
+
|
|
1469
|
+
Name | Type | Description | Notes
|
|
1470
|
+
------------- | ------------- | ------------- | -------------
|
|
1471
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1472
|
+
**count** | **String**| Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000. | [optional]
|
|
1473
|
+
**envelopes_not_shared_user_status** | **String**| | [optional]
|
|
1474
|
+
**folder_ids** | **String**| | [optional]
|
|
1475
|
+
**item_type** | **String**| Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users. | [optional]
|
|
1476
|
+
**search_text** | **String**| This can be used to filter user names in the response. The wild-card ‘*’ (asterisk) can be used around the string. | [optional]
|
|
1477
|
+
**shared** | **String**| Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user | [optional]
|
|
1478
|
+
**start_position** | **String**| If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0. | [optional]
|
|
1479
|
+
**user_ids** | **String**| A comma separated list of userIds for whom the shared item information is being requested. | [optional]
|
|
1480
|
+
|
|
1481
|
+
### Return type
|
|
1482
|
+
|
|
1483
|
+
[**AccountSharedAccess**](AccountSharedAccess.md)
|
|
1484
|
+
|
|
1485
|
+
### Authorization
|
|
1486
|
+
|
|
1487
|
+
No authorization required
|
|
1488
|
+
|
|
1489
|
+
### HTTP request headers
|
|
1490
|
+
|
|
1491
|
+
- **Content-Type**: Not defined
|
|
1492
|
+
- **Accept**: application/json
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
# **list_signature_providers**
|
|
1497
|
+
> AccountSignatureProviders list_signature_providers(account_id)
|
|
1498
|
+
|
|
1499
|
+
Returns Account available signature providers for specified account.
|
|
1500
|
+
|
|
1501
|
+
### Example
|
|
1502
|
+
```ruby
|
|
1503
|
+
# load the gem
|
|
1504
|
+
require 'docusign_esign'
|
|
1505
|
+
|
|
1506
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1507
|
+
|
|
1508
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
begin
|
|
1512
|
+
#Returns Account available signature providers for specified account.
|
|
1513
|
+
result = api_instance.list_signature_providers(account_id)
|
|
1514
|
+
p result
|
|
1515
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1516
|
+
puts "Exception when calling AccountsApi->list_signature_providers: #{e}"
|
|
1517
|
+
end
|
|
1518
|
+
```
|
|
1519
|
+
|
|
1520
|
+
### Parameters
|
|
1521
|
+
|
|
1522
|
+
Name | Type | Description | Notes
|
|
1523
|
+
------------- | ------------- | ------------- | -------------
|
|
1524
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1525
|
+
|
|
1526
|
+
### Return type
|
|
1527
|
+
|
|
1528
|
+
[**AccountSignatureProviders**](AccountSignatureProviders.md)
|
|
1529
|
+
|
|
1530
|
+
### Authorization
|
|
1531
|
+
|
|
1532
|
+
No authorization required
|
|
1533
|
+
|
|
1534
|
+
### HTTP request headers
|
|
1535
|
+
|
|
1536
|
+
- **Content-Type**: Not defined
|
|
1537
|
+
- **Accept**: application/json
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
# **list_unsupported_file_types**
|
|
1542
|
+
> FileTypeList list_unsupported_file_types(account_id)
|
|
1543
|
+
|
|
1544
|
+
Gets a list of unsupported file types.
|
|
1545
|
+
|
|
1546
|
+
Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.
|
|
1547
|
+
|
|
1548
|
+
### Example
|
|
1549
|
+
```ruby
|
|
1550
|
+
# load the gem
|
|
1551
|
+
require 'docusign_esign'
|
|
1552
|
+
|
|
1553
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1554
|
+
|
|
1555
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1556
|
+
|
|
1557
|
+
|
|
1558
|
+
begin
|
|
1559
|
+
#Gets a list of unsupported file types.
|
|
1560
|
+
result = api_instance.list_unsupported_file_types(account_id)
|
|
1561
|
+
p result
|
|
1562
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1563
|
+
puts "Exception when calling AccountsApi->list_unsupported_file_types: #{e}"
|
|
1564
|
+
end
|
|
1565
|
+
```
|
|
1566
|
+
|
|
1567
|
+
### Parameters
|
|
1568
|
+
|
|
1569
|
+
Name | Type | Description | Notes
|
|
1570
|
+
------------- | ------------- | ------------- | -------------
|
|
1571
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1572
|
+
|
|
1573
|
+
### Return type
|
|
1574
|
+
|
|
1575
|
+
[**FileTypeList**](FileTypeList.md)
|
|
1576
|
+
|
|
1577
|
+
### Authorization
|
|
1578
|
+
|
|
1579
|
+
No authorization required
|
|
1580
|
+
|
|
1581
|
+
### HTTP request headers
|
|
1582
|
+
|
|
1583
|
+
- **Content-Type**: Not defined
|
|
1584
|
+
- **Accept**: application/json
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
# **update_account_tab_settings**
|
|
1589
|
+
> TabAccountSettings update_account_tab_settings(account_id, opts)
|
|
1590
|
+
|
|
1591
|
+
Modifies tab settings for specified account
|
|
1592
|
+
|
|
1593
|
+
### Example
|
|
1594
|
+
```ruby
|
|
1595
|
+
# load the gem
|
|
1596
|
+
require 'docusign_esign'
|
|
1597
|
+
|
|
1598
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1599
|
+
|
|
1600
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1601
|
+
|
|
1602
|
+
opts = {
|
|
1603
|
+
tab_account_settings: DocuSign_eSign::TabAccountSettings.new # TabAccountSettings |
|
|
1604
|
+
}
|
|
1605
|
+
|
|
1606
|
+
begin
|
|
1607
|
+
#Modifies tab settings for specified account
|
|
1608
|
+
result = api_instance.update_account_tab_settings(account_id, opts)
|
|
1609
|
+
p result
|
|
1610
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1611
|
+
puts "Exception when calling AccountsApi->update_account_tab_settings: #{e}"
|
|
1612
|
+
end
|
|
1613
|
+
```
|
|
1614
|
+
|
|
1615
|
+
### Parameters
|
|
1616
|
+
|
|
1617
|
+
Name | Type | Description | Notes
|
|
1618
|
+
------------- | ------------- | ------------- | -------------
|
|
1619
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1620
|
+
**tab_account_settings** | [**TabAccountSettings**](TabAccountSettings.md)| | [optional]
|
|
1621
|
+
|
|
1622
|
+
### Return type
|
|
1623
|
+
|
|
1624
|
+
[**TabAccountSettings**](TabAccountSettings.md)
|
|
1625
|
+
|
|
1626
|
+
### Authorization
|
|
1627
|
+
|
|
1628
|
+
No authorization required
|
|
1629
|
+
|
|
1630
|
+
### HTTP request headers
|
|
1631
|
+
|
|
1632
|
+
- **Content-Type**: Not defined
|
|
1633
|
+
- **Accept**: application/json
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
# **update_brand**
|
|
1638
|
+
> Brand update_brand(account_id, brand_id, opts)
|
|
1639
|
+
|
|
1640
|
+
Updates an existing brand.
|
|
1641
|
+
|
|
1642
|
+
### Example
|
|
1643
|
+
```ruby
|
|
1644
|
+
# load the gem
|
|
1645
|
+
require 'docusign_esign'
|
|
1646
|
+
|
|
1647
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1648
|
+
|
|
1649
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1650
|
+
|
|
1651
|
+
brand_id = "brand_id_example" # String | The unique identifier of a brand.
|
|
1652
|
+
|
|
1653
|
+
opts = {
|
|
1654
|
+
brand: DocuSign_eSign::Brand.new # Brand |
|
|
1655
|
+
}
|
|
1656
|
+
|
|
1657
|
+
begin
|
|
1658
|
+
#Updates an existing brand.
|
|
1659
|
+
result = api_instance.update_brand(account_id, brand_id, opts)
|
|
1660
|
+
p result
|
|
1661
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1662
|
+
puts "Exception when calling AccountsApi->update_brand: #{e}"
|
|
1663
|
+
end
|
|
1664
|
+
```
|
|
1665
|
+
|
|
1666
|
+
### Parameters
|
|
1667
|
+
|
|
1668
|
+
Name | Type | Description | Notes
|
|
1669
|
+
------------- | ------------- | ------------- | -------------
|
|
1670
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1671
|
+
**brand_id** | **String**| The unique identifier of a brand. |
|
|
1672
|
+
**brand** | [**Brand**](Brand.md)| | [optional]
|
|
1673
|
+
|
|
1674
|
+
### Return type
|
|
1675
|
+
|
|
1676
|
+
[**Brand**](Brand.md)
|
|
1677
|
+
|
|
1678
|
+
### Authorization
|
|
1679
|
+
|
|
1680
|
+
No authorization required
|
|
1681
|
+
|
|
1682
|
+
### HTTP request headers
|
|
1683
|
+
|
|
1684
|
+
- **Content-Type**: Not defined
|
|
1685
|
+
- **Accept**: application/json
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
# **update_brand_logo_by_type**
|
|
1690
|
+
> update_brand_logo_by_type(account_id, brand_id, logo_type)
|
|
1691
|
+
|
|
1692
|
+
Put one branding logo.
|
|
1693
|
+
|
|
1694
|
+
### Example
|
|
1695
|
+
```ruby
|
|
1696
|
+
# load the gem
|
|
1697
|
+
require 'docusign_esign'
|
|
1698
|
+
|
|
1699
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1700
|
+
|
|
1701
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1702
|
+
|
|
1703
|
+
brand_id = "brand_id_example" # String | The unique identifier of a brand.
|
|
1704
|
+
|
|
1705
|
+
logo_type = "logo_type_example" # String | One of **Primary**, **Secondary** or **Email**.
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
begin
|
|
1709
|
+
#Put one branding logo.
|
|
1710
|
+
api_instance.update_brand_logo_by_type(account_id, brand_id, logo_type)
|
|
1711
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1712
|
+
puts "Exception when calling AccountsApi->update_brand_logo_by_type: #{e}"
|
|
1713
|
+
end
|
|
1714
|
+
```
|
|
1715
|
+
|
|
1716
|
+
### Parameters
|
|
1717
|
+
|
|
1718
|
+
Name | Type | Description | Notes
|
|
1719
|
+
------------- | ------------- | ------------- | -------------
|
|
1720
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1721
|
+
**brand_id** | **String**| The unique identifier of a brand. |
|
|
1722
|
+
**logo_type** | **String**| One of **Primary**, **Secondary** or **Email**. |
|
|
1723
|
+
|
|
1724
|
+
### Return type
|
|
1725
|
+
|
|
1726
|
+
nil (empty response body)
|
|
1727
|
+
|
|
1728
|
+
### Authorization
|
|
1729
|
+
|
|
1730
|
+
No authorization required
|
|
1731
|
+
|
|
1732
|
+
### HTTP request headers
|
|
1733
|
+
|
|
1734
|
+
- **Content-Type**: Not defined
|
|
1735
|
+
- **Accept**: application/json
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
# **update_brand_resources_by_content_type**
|
|
1740
|
+
> BrandResources update_brand_resources_by_content_type(account_id, brand_id, resource_content_type)
|
|
1741
|
+
|
|
1742
|
+
Uploads a branding resource file.
|
|
1743
|
+
|
|
1744
|
+
### Example
|
|
1745
|
+
```ruby
|
|
1746
|
+
# load the gem
|
|
1747
|
+
require 'docusign_esign'
|
|
1748
|
+
|
|
1749
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1750
|
+
|
|
1751
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1752
|
+
|
|
1753
|
+
brand_id = "brand_id_example" # String | The unique identifier of a brand.
|
|
1754
|
+
|
|
1755
|
+
resource_content_type = "resource_content_type_example" # String |
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
begin
|
|
1759
|
+
#Uploads a branding resource file.
|
|
1760
|
+
result = api_instance.update_brand_resources_by_content_type(account_id, brand_id, resource_content_type)
|
|
1761
|
+
p result
|
|
1762
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1763
|
+
puts "Exception when calling AccountsApi->update_brand_resources_by_content_type: #{e}"
|
|
1764
|
+
end
|
|
1765
|
+
```
|
|
1766
|
+
|
|
1767
|
+
### Parameters
|
|
1768
|
+
|
|
1769
|
+
Name | Type | Description | Notes
|
|
1770
|
+
------------- | ------------- | ------------- | -------------
|
|
1771
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1772
|
+
**brand_id** | **String**| The unique identifier of a brand. |
|
|
1773
|
+
**resource_content_type** | **String**| |
|
|
1774
|
+
|
|
1775
|
+
### Return type
|
|
1776
|
+
|
|
1777
|
+
[**BrandResources**](BrandResources.md)
|
|
1778
|
+
|
|
1779
|
+
### Authorization
|
|
1780
|
+
|
|
1781
|
+
No authorization required
|
|
1782
|
+
|
|
1783
|
+
### HTTP request headers
|
|
1784
|
+
|
|
1785
|
+
- **Content-Type**: Not defined
|
|
1786
|
+
- **Accept**: application/json
|
|
1787
|
+
|
|
1788
|
+
|
|
1789
|
+
|
|
1790
|
+
# **update_e_note_configuration**
|
|
1791
|
+
> ENoteConfiguration update_e_note_configuration(account_id, opts)
|
|
1792
|
+
|
|
1793
|
+
Updates configuration information for the eNote eOriginal integration.
|
|
1794
|
+
|
|
1795
|
+
### Example
|
|
1796
|
+
```ruby
|
|
1797
|
+
# load the gem
|
|
1798
|
+
require 'docusign_esign'
|
|
1799
|
+
|
|
1800
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1801
|
+
|
|
1802
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1803
|
+
|
|
1804
|
+
opts = {
|
|
1805
|
+
e_note_configuration: DocuSign_eSign::ENoteConfiguration.new # ENoteConfiguration |
|
|
1806
|
+
}
|
|
1807
|
+
|
|
1808
|
+
begin
|
|
1809
|
+
#Updates configuration information for the eNote eOriginal integration.
|
|
1810
|
+
result = api_instance.update_e_note_configuration(account_id, opts)
|
|
1811
|
+
p result
|
|
1812
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1813
|
+
puts "Exception when calling AccountsApi->update_e_note_configuration: #{e}"
|
|
1814
|
+
end
|
|
1815
|
+
```
|
|
1816
|
+
|
|
1817
|
+
### Parameters
|
|
1818
|
+
|
|
1819
|
+
Name | Type | Description | Notes
|
|
1820
|
+
------------- | ------------- | ------------- | -------------
|
|
1821
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1822
|
+
**e_note_configuration** | [**ENoteConfiguration**](ENoteConfiguration.md)| | [optional]
|
|
1823
|
+
|
|
1824
|
+
### Return type
|
|
1825
|
+
|
|
1826
|
+
[**ENoteConfiguration**](ENoteConfiguration.md)
|
|
1827
|
+
|
|
1828
|
+
### Authorization
|
|
1829
|
+
|
|
1830
|
+
No authorization required
|
|
1831
|
+
|
|
1832
|
+
### HTTP request headers
|
|
1833
|
+
|
|
1834
|
+
- **Content-Type**: Not defined
|
|
1835
|
+
- **Accept**: application/json
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
|
|
1839
|
+
# **update_permission_profile**
|
|
1840
|
+
> PermissionProfile update_permission_profile(account_id, permission_profile_id, opts)
|
|
1841
|
+
|
|
1842
|
+
Updates a permission profile within the specified account.
|
|
1843
|
+
|
|
1844
|
+
### Example
|
|
1845
|
+
```ruby
|
|
1846
|
+
# load the gem
|
|
1847
|
+
require 'docusign_esign'
|
|
1848
|
+
|
|
1849
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1850
|
+
|
|
1851
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1852
|
+
|
|
1853
|
+
permission_profile_id = "permission_profile_id_example" # String |
|
|
1854
|
+
|
|
1855
|
+
opts = {
|
|
1856
|
+
include: "include_example", # String |
|
|
1857
|
+
permission_profile: DocuSign_eSign::PermissionProfile.new # PermissionProfile |
|
|
1858
|
+
}
|
|
1859
|
+
|
|
1860
|
+
begin
|
|
1861
|
+
#Updates a permission profile within the specified account.
|
|
1862
|
+
result = api_instance.update_permission_profile(account_id, permission_profile_id, opts)
|
|
1863
|
+
p result
|
|
1864
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1865
|
+
puts "Exception when calling AccountsApi->update_permission_profile: #{e}"
|
|
1866
|
+
end
|
|
1867
|
+
```
|
|
1868
|
+
|
|
1869
|
+
### Parameters
|
|
1870
|
+
|
|
1871
|
+
Name | Type | Description | Notes
|
|
1872
|
+
------------- | ------------- | ------------- | -------------
|
|
1873
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1874
|
+
**permission_profile_id** | **String**| |
|
|
1875
|
+
**include** | **String**| | [optional]
|
|
1876
|
+
**permission_profile** | [**PermissionProfile**](PermissionProfile.md)| | [optional]
|
|
1877
|
+
|
|
1878
|
+
### Return type
|
|
1879
|
+
|
|
1880
|
+
[**PermissionProfile**](PermissionProfile.md)
|
|
1881
|
+
|
|
1882
|
+
### Authorization
|
|
1883
|
+
|
|
1884
|
+
No authorization required
|
|
1885
|
+
|
|
1886
|
+
### HTTP request headers
|
|
1887
|
+
|
|
1888
|
+
- **Content-Type**: Not defined
|
|
1889
|
+
- **Accept**: application/json
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
# **update_settings**
|
|
1894
|
+
> update_settings(account_id, opts)
|
|
1895
|
+
|
|
1896
|
+
Updates the account settings for an account.
|
|
1897
|
+
|
|
1898
|
+
Updates the account settings for the specified account.
|
|
1899
|
+
|
|
1900
|
+
### Example
|
|
1901
|
+
```ruby
|
|
1902
|
+
# load the gem
|
|
1903
|
+
require 'docusign_esign'
|
|
1904
|
+
|
|
1905
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1906
|
+
|
|
1907
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1908
|
+
|
|
1909
|
+
opts = {
|
|
1910
|
+
account_settings_information: DocuSign_eSign::AccountSettingsInformation.new # AccountSettingsInformation |
|
|
1911
|
+
}
|
|
1912
|
+
|
|
1913
|
+
begin
|
|
1914
|
+
#Updates the account settings for an account.
|
|
1915
|
+
api_instance.update_settings(account_id, opts)
|
|
1916
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1917
|
+
puts "Exception when calling AccountsApi->update_settings: #{e}"
|
|
1918
|
+
end
|
|
1919
|
+
```
|
|
1920
|
+
|
|
1921
|
+
### Parameters
|
|
1922
|
+
|
|
1923
|
+
Name | Type | Description | Notes
|
|
1924
|
+
------------- | ------------- | ------------- | -------------
|
|
1925
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1926
|
+
**account_settings_information** | [**AccountSettingsInformation**](AccountSettingsInformation.md)| | [optional]
|
|
1927
|
+
|
|
1928
|
+
### Return type
|
|
1929
|
+
|
|
1930
|
+
nil (empty response body)
|
|
1931
|
+
|
|
1932
|
+
### Authorization
|
|
1933
|
+
|
|
1934
|
+
No authorization required
|
|
1935
|
+
|
|
1936
|
+
### HTTP request headers
|
|
1937
|
+
|
|
1938
|
+
- **Content-Type**: Not defined
|
|
1939
|
+
- **Accept**: application/json
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
# **update_shared_access**
|
|
1944
|
+
> AccountSharedAccess update_shared_access(account_id, opts)
|
|
1945
|
+
|
|
1946
|
+
Reserved: Sets the shared access information for users.
|
|
1947
|
+
|
|
1948
|
+
Reserved: Sets the shared access information for one or more users.
|
|
1949
|
+
|
|
1950
|
+
### Example
|
|
1951
|
+
```ruby
|
|
1952
|
+
# load the gem
|
|
1953
|
+
require 'docusign_esign'
|
|
1954
|
+
|
|
1955
|
+
api_instance = DocuSign_eSign::AccountsApi.new
|
|
1956
|
+
|
|
1957
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
1958
|
+
|
|
1959
|
+
opts = {
|
|
1960
|
+
item_type: "item_type_example", # String |
|
|
1961
|
+
user_ids: "user_ids_example", # String |
|
|
1962
|
+
account_shared_access: DocuSign_eSign::AccountSharedAccess.new # AccountSharedAccess |
|
|
1963
|
+
}
|
|
1964
|
+
|
|
1965
|
+
begin
|
|
1966
|
+
#Reserved: Sets the shared access information for users.
|
|
1967
|
+
result = api_instance.update_shared_access(account_id, opts)
|
|
1968
|
+
p result
|
|
1969
|
+
rescue DocuSign_eSign::ApiError => e
|
|
1970
|
+
puts "Exception when calling AccountsApi->update_shared_access: #{e}"
|
|
1971
|
+
end
|
|
1972
|
+
```
|
|
1973
|
+
|
|
1974
|
+
### Parameters
|
|
1975
|
+
|
|
1976
|
+
Name | Type | Description | Notes
|
|
1977
|
+
------------- | ------------- | ------------- | -------------
|
|
1978
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
1979
|
+
**item_type** | **String**| | [optional]
|
|
1980
|
+
**user_ids** | **String**| | [optional]
|
|
1981
|
+
**account_shared_access** | [**AccountSharedAccess**](AccountSharedAccess.md)| | [optional]
|
|
1982
|
+
|
|
1983
|
+
### Return type
|
|
1984
|
+
|
|
1985
|
+
[**AccountSharedAccess**](AccountSharedAccess.md)
|
|
1986
|
+
|
|
1987
|
+
### Authorization
|
|
1988
|
+
|
|
1989
|
+
No authorization required
|
|
1990
|
+
|
|
1991
|
+
### HTTP request headers
|
|
1992
|
+
|
|
1993
|
+
- **Content-Type**: Not defined
|
|
1994
|
+
- **Accept**: application/json
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
|