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
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# DocuSign_eSign::CloudStorageProvider
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**authentication_url** | **String** | The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. | [optional]
|
|
7
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
8
|
+
**redirect_url** | **String** | The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains. | [optional]
|
|
9
|
+
**service** | **String** | The service name for the cloud storage provider. | [optional]
|
|
10
|
+
**service_id** | **String** | The DocuSign generated ID for the cloud storage provider | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# DocuSign_eSign::CloudStorageProviders
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**storage_providers** | [**Array<CloudStorageProvider>**](CloudStorageProvider.md) | An Array containing the storage providers associated with the user. | [optional]
|
|
7
|
+
|
|
8
|
+
|
data/docs/Company.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# DocuSign_eSign::Company
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**anchor_case_sensitive** | **String** | When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. | [optional]
|
|
7
|
+
**anchor_horizontal_alignment** | **String** | Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. | [optional]
|
|
8
|
+
**anchor_ignore_if_not_present** | **String** | When set to **true**, this tab is ignored if anchorString is not found in the document. | [optional]
|
|
9
|
+
**anchor_match_whole_word** | **String** | When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. | [optional]
|
|
10
|
+
**anchor_string** | **String** | Anchor text information for a radio button. | [optional]
|
|
11
|
+
**anchor_units** | **String** | Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. | [optional]
|
|
12
|
+
**anchor_x_offset** | **String** | Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
|
|
13
|
+
**anchor_y_offset** | **String** | Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
|
|
14
|
+
**bold** | **String** | When set to **true**, the information in the tab is bold. | [optional]
|
|
15
|
+
**conceal_value_on_document** | **String** | When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. | [optional]
|
|
16
|
+
**conditional_parent_label** | **String** | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | [optional]
|
|
17
|
+
**conditional_parent_value** | **String** | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. | [optional]
|
|
18
|
+
**custom_tab_id** | **String** | The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. | [optional]
|
|
19
|
+
**disable_auto_size** | **String** | When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. | [optional]
|
|
20
|
+
**document_id** | **String** | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. | [optional]
|
|
21
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
22
|
+
**font** | **String** | The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. | [optional]
|
|
23
|
+
**font_color** | **String** | The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. | [optional]
|
|
24
|
+
**font_size** | **String** | The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. | [optional]
|
|
25
|
+
**italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
|
|
26
|
+
**locked** | **String** | When set to **true**, the signer cannot change the data of the custom tab. | [optional]
|
|
27
|
+
**max_length** | **Integer** | An optional value that describes the maximum length of the property when the property is a string. | [optional]
|
|
28
|
+
**merge_field** | [**MergeField**](MergeField.md) | | [optional]
|
|
29
|
+
**name** | **String** | Specifies the tool tip text for the tab. | [optional]
|
|
30
|
+
**original_value** | **String** | The initial value of the tab when it was sent to the recipient. | [optional]
|
|
31
|
+
**page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
|
|
32
|
+
**recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
|
|
33
|
+
**required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
|
|
34
|
+
**status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
|
|
35
|
+
**tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
|
|
36
|
+
**tab_label** | **String** | The label string associated with the tab. | [optional]
|
|
37
|
+
**tab_order** | **String** | | [optional]
|
|
38
|
+
**template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
|
|
39
|
+
**template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
|
|
40
|
+
**underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
|
|
41
|
+
**value** | **String** | Specifies the value of the tab. | [optional]
|
|
42
|
+
**width** | **Integer** | Width of the tab in pixels. | [optional]
|
|
43
|
+
**x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
44
|
+
**y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
45
|
+
|
|
46
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# DocuSign_eSign::CompositeTemplate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**composite_template_id** | **String** | The identify of this composite template. It is used as a reference when adding document object information. If used, the document’s `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. | [optional]
|
|
7
|
+
**document** | [**Document**](Document.md) | | [optional]
|
|
8
|
+
**inline_templates** | [**Array<InlineTemplate>**](InlineTemplate.md) | Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. | [optional]
|
|
9
|
+
**pdf_meta_data_template_sequence** | **String** | | [optional]
|
|
10
|
+
**server_templates** | [**Array<ServerTemplate>**](ServerTemplate.md) | 0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/ConnectApi.md
ADDED
|
@@ -0,0 +1,891 @@
|
|
|
1
|
+
# DocuSign_eSign::ConnectApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://www.docusign.net/restapi*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_configuration**](ConnectApi.md#create_configuration) | **POST** /v2/accounts/{accountId}/connect | Creates a connect configuration for the specified account.
|
|
8
|
+
[**delete_configuration**](ConnectApi.md#delete_configuration) | **DELETE** /v2/accounts/{accountId}/connect/{connectId} | Deletes the specified connect configuration.
|
|
9
|
+
[**delete_event_failure_log**](ConnectApi.md#delete_event_failure_log) | **DELETE** /v2/accounts/{accountId}/connect/failures/{failureId} | Deletes a Connect failure log entry.
|
|
10
|
+
[**delete_event_log**](ConnectApi.md#delete_event_log) | **DELETE** /v2/accounts/{accountId}/connect/logs/{logId} | Deletes a specified Connect log entry.
|
|
11
|
+
[**delete_event_logs**](ConnectApi.md#delete_event_logs) | **DELETE** /v2/accounts/{accountId}/connect/logs | Gets a list of Connect log entries.
|
|
12
|
+
[**delete_mobile_notifiers**](ConnectApi.md#delete_mobile_notifiers) | **DELETE** /v2/accounts/{accountId}/connect/mobile_notifiers | Reserved
|
|
13
|
+
[**get_configuration**](ConnectApi.md#get_configuration) | **GET** /v2/accounts/{accountId}/connect/{connectId} | Get a Connect Configuration Information
|
|
14
|
+
[**get_event_log**](ConnectApi.md#get_event_log) | **GET** /v2/accounts/{accountId}/connect/logs/{logId} | Get the specified Connect log entry.
|
|
15
|
+
[**list_configurations**](ConnectApi.md#list_configurations) | **GET** /v2/accounts/{accountId}/connect | Get Connect Configuration Information
|
|
16
|
+
[**list_event_failure_logs**](ConnectApi.md#list_event_failure_logs) | **GET** /v2/accounts/{accountId}/connect/failures | Gets the Connect failure log information.
|
|
17
|
+
[**list_event_logs**](ConnectApi.md#list_event_logs) | **GET** /v2/accounts/{accountId}/connect/logs | Gets the Connect log.
|
|
18
|
+
[**list_mobile_notifiers**](ConnectApi.md#list_mobile_notifiers) | **GET** /v2/accounts/{accountId}/connect/mobile_notifiers | Reserved
|
|
19
|
+
[**list_users**](ConnectApi.md#list_users) | **GET** /v2/accounts/{accountId}/connect/{connectId}/users | Returns users from the configured Connect service.
|
|
20
|
+
[**retry_event_for_envelope**](ConnectApi.md#retry_event_for_envelope) | **PUT** /v2/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue | Republishes Connect information for the specified envelope.
|
|
21
|
+
[**retry_event_for_envelopes**](ConnectApi.md#retry_event_for_envelopes) | **PUT** /v2/accounts/{accountId}/connect/envelopes/retry_queue | Republishes Connect information for multiple envelopes.
|
|
22
|
+
[**update_configuration**](ConnectApi.md#update_configuration) | **PUT** /v2/accounts/{accountId}/connect | Updates a specified Connect configuration.
|
|
23
|
+
[**update_mobile_notifiers**](ConnectApi.md#update_mobile_notifiers) | **PUT** /v2/accounts/{accountId}/connect/mobile_notifiers | Reserved
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
# **create_configuration**
|
|
27
|
+
> ConnectCustomConfiguration create_configuration(account_id, opts)
|
|
28
|
+
|
|
29
|
+
Creates a connect configuration for the specified account.
|
|
30
|
+
|
|
31
|
+
Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide]. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.
|
|
32
|
+
|
|
33
|
+
### Example
|
|
34
|
+
```ruby
|
|
35
|
+
# load the gem
|
|
36
|
+
require 'docusign_esign'
|
|
37
|
+
|
|
38
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
39
|
+
|
|
40
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
41
|
+
|
|
42
|
+
opts = {
|
|
43
|
+
connect_custom_configuration: DocuSign_eSign::ConnectCustomConfiguration.new # ConnectCustomConfiguration |
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
#Creates a connect configuration for the specified account.
|
|
48
|
+
result = api_instance.create_configuration(account_id, opts)
|
|
49
|
+
p result
|
|
50
|
+
rescue DocuSign_eSign::ApiError => e
|
|
51
|
+
puts "Exception when calling ConnectApi->create_configuration: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
Name | Type | Description | Notes
|
|
58
|
+
------------- | ------------- | ------------- | -------------
|
|
59
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
60
|
+
**connect_custom_configuration** | [**ConnectCustomConfiguration**](ConnectCustomConfiguration.md)| | [optional]
|
|
61
|
+
|
|
62
|
+
### Return type
|
|
63
|
+
|
|
64
|
+
[**ConnectCustomConfiguration**](ConnectCustomConfiguration.md)
|
|
65
|
+
|
|
66
|
+
### Authorization
|
|
67
|
+
|
|
68
|
+
No authorization required
|
|
69
|
+
|
|
70
|
+
### HTTP request headers
|
|
71
|
+
|
|
72
|
+
- **Content-Type**: Not defined
|
|
73
|
+
- **Accept**: application/json
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
# **delete_configuration**
|
|
78
|
+
> delete_configuration(account_id, connect_id)
|
|
79
|
+
|
|
80
|
+
Deletes the specified connect configuration.
|
|
81
|
+
|
|
82
|
+
Deletes the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
```ruby
|
|
86
|
+
# load the gem
|
|
87
|
+
require 'docusign_esign'
|
|
88
|
+
|
|
89
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
90
|
+
|
|
91
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
92
|
+
|
|
93
|
+
connect_id = "connect_id_example" # String | The ID of the custom Connect configuration being accessed.
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
begin
|
|
97
|
+
#Deletes the specified connect configuration.
|
|
98
|
+
api_instance.delete_configuration(account_id, connect_id)
|
|
99
|
+
rescue DocuSign_eSign::ApiError => e
|
|
100
|
+
puts "Exception when calling ConnectApi->delete_configuration: #{e}"
|
|
101
|
+
end
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Parameters
|
|
105
|
+
|
|
106
|
+
Name | Type | Description | Notes
|
|
107
|
+
------------- | ------------- | ------------- | -------------
|
|
108
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
109
|
+
**connect_id** | **String**| The ID of the custom Connect configuration being accessed. |
|
|
110
|
+
|
|
111
|
+
### Return type
|
|
112
|
+
|
|
113
|
+
nil (empty response body)
|
|
114
|
+
|
|
115
|
+
### Authorization
|
|
116
|
+
|
|
117
|
+
No authorization required
|
|
118
|
+
|
|
119
|
+
### HTTP request headers
|
|
120
|
+
|
|
121
|
+
- **Content-Type**: Not defined
|
|
122
|
+
- **Accept**: application/json
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
# **delete_event_failure_log**
|
|
127
|
+
> delete_event_failure_log(account_id, failure_id)
|
|
128
|
+
|
|
129
|
+
Deletes a Connect failure log entry.
|
|
130
|
+
|
|
131
|
+
Deletes the Connect failure log information for the specified entry.
|
|
132
|
+
|
|
133
|
+
### Example
|
|
134
|
+
```ruby
|
|
135
|
+
# load the gem
|
|
136
|
+
require 'docusign_esign'
|
|
137
|
+
|
|
138
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
139
|
+
|
|
140
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
141
|
+
|
|
142
|
+
failure_id = "failure_id_example" # String | The ID of the failed connect log entry.
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
begin
|
|
146
|
+
#Deletes a Connect failure log entry.
|
|
147
|
+
api_instance.delete_event_failure_log(account_id, failure_id)
|
|
148
|
+
rescue DocuSign_eSign::ApiError => e
|
|
149
|
+
puts "Exception when calling ConnectApi->delete_event_failure_log: #{e}"
|
|
150
|
+
end
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Parameters
|
|
154
|
+
|
|
155
|
+
Name | Type | Description | Notes
|
|
156
|
+
------------- | ------------- | ------------- | -------------
|
|
157
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
158
|
+
**failure_id** | **String**| The ID of the failed connect log entry. |
|
|
159
|
+
|
|
160
|
+
### Return type
|
|
161
|
+
|
|
162
|
+
nil (empty response body)
|
|
163
|
+
|
|
164
|
+
### Authorization
|
|
165
|
+
|
|
166
|
+
No authorization required
|
|
167
|
+
|
|
168
|
+
### HTTP request headers
|
|
169
|
+
|
|
170
|
+
- **Content-Type**: Not defined
|
|
171
|
+
- **Accept**: application/json
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
# **delete_event_log**
|
|
176
|
+
> delete_event_log(account_id, log_id)
|
|
177
|
+
|
|
178
|
+
Deletes a specified Connect log entry.
|
|
179
|
+
|
|
180
|
+
Deletes a specified entry from the Connect Log.
|
|
181
|
+
|
|
182
|
+
### Example
|
|
183
|
+
```ruby
|
|
184
|
+
# load the gem
|
|
185
|
+
require 'docusign_esign'
|
|
186
|
+
|
|
187
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
188
|
+
|
|
189
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
190
|
+
|
|
191
|
+
log_id = "log_id_example" # String | The ID of the connect log entry
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
begin
|
|
195
|
+
#Deletes a specified Connect log entry.
|
|
196
|
+
api_instance.delete_event_log(account_id, log_id)
|
|
197
|
+
rescue DocuSign_eSign::ApiError => e
|
|
198
|
+
puts "Exception when calling ConnectApi->delete_event_log: #{e}"
|
|
199
|
+
end
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Parameters
|
|
203
|
+
|
|
204
|
+
Name | Type | Description | Notes
|
|
205
|
+
------------- | ------------- | ------------- | -------------
|
|
206
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
207
|
+
**log_id** | **String**| The ID of the connect log entry |
|
|
208
|
+
|
|
209
|
+
### Return type
|
|
210
|
+
|
|
211
|
+
nil (empty response body)
|
|
212
|
+
|
|
213
|
+
### Authorization
|
|
214
|
+
|
|
215
|
+
No authorization required
|
|
216
|
+
|
|
217
|
+
### HTTP request headers
|
|
218
|
+
|
|
219
|
+
- **Content-Type**: Not defined
|
|
220
|
+
- **Accept**: application/json
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
# **delete_event_logs**
|
|
225
|
+
> delete_event_logs(account_id)
|
|
226
|
+
|
|
227
|
+
Gets a list of Connect log entries.
|
|
228
|
+
|
|
229
|
+
Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` property in the Connect configuration must be set to **true** to enable logging. If logging is not enabled, then no log entries are recorded.
|
|
230
|
+
|
|
231
|
+
### Example
|
|
232
|
+
```ruby
|
|
233
|
+
# load the gem
|
|
234
|
+
require 'docusign_esign'
|
|
235
|
+
|
|
236
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
237
|
+
|
|
238
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
begin
|
|
242
|
+
#Gets a list of Connect log entries.
|
|
243
|
+
api_instance.delete_event_logs(account_id)
|
|
244
|
+
rescue DocuSign_eSign::ApiError => e
|
|
245
|
+
puts "Exception when calling ConnectApi->delete_event_logs: #{e}"
|
|
246
|
+
end
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Parameters
|
|
250
|
+
|
|
251
|
+
Name | Type | Description | Notes
|
|
252
|
+
------------- | ------------- | ------------- | -------------
|
|
253
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
254
|
+
|
|
255
|
+
### Return type
|
|
256
|
+
|
|
257
|
+
nil (empty response body)
|
|
258
|
+
|
|
259
|
+
### Authorization
|
|
260
|
+
|
|
261
|
+
No authorization required
|
|
262
|
+
|
|
263
|
+
### HTTP request headers
|
|
264
|
+
|
|
265
|
+
- **Content-Type**: Not defined
|
|
266
|
+
- **Accept**: application/json
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
# **delete_mobile_notifiers**
|
|
271
|
+
> MobileNotifierConfigurationInformation delete_mobile_notifiers(account_id, opts)
|
|
272
|
+
|
|
273
|
+
Reserved
|
|
274
|
+
|
|
275
|
+
Reserved:
|
|
276
|
+
|
|
277
|
+
### Example
|
|
278
|
+
```ruby
|
|
279
|
+
# load the gem
|
|
280
|
+
require 'docusign_esign'
|
|
281
|
+
|
|
282
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
283
|
+
|
|
284
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
285
|
+
|
|
286
|
+
opts = {
|
|
287
|
+
mobile_notifier_configuration_information: DocuSign_eSign::MobileNotifierConfigurationInformation.new # MobileNotifierConfigurationInformation |
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
begin
|
|
291
|
+
#Reserved
|
|
292
|
+
result = api_instance.delete_mobile_notifiers(account_id, opts)
|
|
293
|
+
p result
|
|
294
|
+
rescue DocuSign_eSign::ApiError => e
|
|
295
|
+
puts "Exception when calling ConnectApi->delete_mobile_notifiers: #{e}"
|
|
296
|
+
end
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### Parameters
|
|
300
|
+
|
|
301
|
+
Name | Type | Description | Notes
|
|
302
|
+
------------- | ------------- | ------------- | -------------
|
|
303
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
304
|
+
**mobile_notifier_configuration_information** | [**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)| | [optional]
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
[**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)
|
|
309
|
+
|
|
310
|
+
### Authorization
|
|
311
|
+
|
|
312
|
+
No authorization required
|
|
313
|
+
|
|
314
|
+
### HTTP request headers
|
|
315
|
+
|
|
316
|
+
- **Content-Type**: Not defined
|
|
317
|
+
- **Accept**: application/json
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
# **get_configuration**
|
|
322
|
+
> ConnectConfigResults get_configuration(account_id, connect_id)
|
|
323
|
+
|
|
324
|
+
Get a Connect Configuration Information
|
|
325
|
+
|
|
326
|
+
Retrieves the information for the specified DocuSign Connect configuration. ###### Note: Connect must be enabled for your account to use this function.
|
|
327
|
+
|
|
328
|
+
### Example
|
|
329
|
+
```ruby
|
|
330
|
+
# load the gem
|
|
331
|
+
require 'docusign_esign'
|
|
332
|
+
|
|
333
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
334
|
+
|
|
335
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
336
|
+
|
|
337
|
+
connect_id = "connect_id_example" # String | The ID of the custom Connect configuration being accessed.
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
begin
|
|
341
|
+
#Get a Connect Configuration Information
|
|
342
|
+
result = api_instance.get_configuration(account_id, connect_id)
|
|
343
|
+
p result
|
|
344
|
+
rescue DocuSign_eSign::ApiError => e
|
|
345
|
+
puts "Exception when calling ConnectApi->get_configuration: #{e}"
|
|
346
|
+
end
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
### Parameters
|
|
350
|
+
|
|
351
|
+
Name | Type | Description | Notes
|
|
352
|
+
------------- | ------------- | ------------- | -------------
|
|
353
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
354
|
+
**connect_id** | **String**| The ID of the custom Connect configuration being accessed. |
|
|
355
|
+
|
|
356
|
+
### Return type
|
|
357
|
+
|
|
358
|
+
[**ConnectConfigResults**](ConnectConfigResults.md)
|
|
359
|
+
|
|
360
|
+
### Authorization
|
|
361
|
+
|
|
362
|
+
No authorization required
|
|
363
|
+
|
|
364
|
+
### HTTP request headers
|
|
365
|
+
|
|
366
|
+
- **Content-Type**: Not defined
|
|
367
|
+
- **Accept**: application/json
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
# **get_event_log**
|
|
372
|
+
> ConnectLog get_event_log(account_id, log_id, opts)
|
|
373
|
+
|
|
374
|
+
Get the specified Connect log entry.
|
|
375
|
+
|
|
376
|
+
Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.
|
|
377
|
+
|
|
378
|
+
### Example
|
|
379
|
+
```ruby
|
|
380
|
+
# load the gem
|
|
381
|
+
require 'docusign_esign'
|
|
382
|
+
|
|
383
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
384
|
+
|
|
385
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
386
|
+
|
|
387
|
+
log_id = "log_id_example" # String | The ID of the connect log entry
|
|
388
|
+
|
|
389
|
+
opts = {
|
|
390
|
+
additional_info: "additional_info_example" # String | When true, the connectDebugLog information is included in the response.
|
|
391
|
+
}
|
|
392
|
+
|
|
393
|
+
begin
|
|
394
|
+
#Get the specified Connect log entry.
|
|
395
|
+
result = api_instance.get_event_log(account_id, log_id, opts)
|
|
396
|
+
p result
|
|
397
|
+
rescue DocuSign_eSign::ApiError => e
|
|
398
|
+
puts "Exception when calling ConnectApi->get_event_log: #{e}"
|
|
399
|
+
end
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
### Parameters
|
|
403
|
+
|
|
404
|
+
Name | Type | Description | Notes
|
|
405
|
+
------------- | ------------- | ------------- | -------------
|
|
406
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
407
|
+
**log_id** | **String**| The ID of the connect log entry |
|
|
408
|
+
**additional_info** | **String**| When true, the connectDebugLog information is included in the response. | [optional]
|
|
409
|
+
|
|
410
|
+
### Return type
|
|
411
|
+
|
|
412
|
+
[**ConnectLog**](ConnectLog.md)
|
|
413
|
+
|
|
414
|
+
### Authorization
|
|
415
|
+
|
|
416
|
+
No authorization required
|
|
417
|
+
|
|
418
|
+
### HTTP request headers
|
|
419
|
+
|
|
420
|
+
- **Content-Type**: Not defined
|
|
421
|
+
- **Accept**: application/json
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
# **list_configurations**
|
|
426
|
+
> ConnectConfigResults list_configurations(account_id)
|
|
427
|
+
|
|
428
|
+
Get Connect Configuration Information
|
|
429
|
+
|
|
430
|
+
Retrieves all the DocuSign Custom Connect definitions for the specified account. ###### Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.
|
|
431
|
+
|
|
432
|
+
### Example
|
|
433
|
+
```ruby
|
|
434
|
+
# load the gem
|
|
435
|
+
require 'docusign_esign'
|
|
436
|
+
|
|
437
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
438
|
+
|
|
439
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
begin
|
|
443
|
+
#Get Connect Configuration Information
|
|
444
|
+
result = api_instance.list_configurations(account_id)
|
|
445
|
+
p result
|
|
446
|
+
rescue DocuSign_eSign::ApiError => e
|
|
447
|
+
puts "Exception when calling ConnectApi->list_configurations: #{e}"
|
|
448
|
+
end
|
|
449
|
+
```
|
|
450
|
+
|
|
451
|
+
### Parameters
|
|
452
|
+
|
|
453
|
+
Name | Type | Description | Notes
|
|
454
|
+
------------- | ------------- | ------------- | -------------
|
|
455
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
456
|
+
|
|
457
|
+
### Return type
|
|
458
|
+
|
|
459
|
+
[**ConnectConfigResults**](ConnectConfigResults.md)
|
|
460
|
+
|
|
461
|
+
### Authorization
|
|
462
|
+
|
|
463
|
+
No authorization required
|
|
464
|
+
|
|
465
|
+
### HTTP request headers
|
|
466
|
+
|
|
467
|
+
- **Content-Type**: Not defined
|
|
468
|
+
- **Accept**: application/json
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
# **list_event_failure_logs**
|
|
473
|
+
> ConnectLogs list_event_failure_logs(account_id, opts)
|
|
474
|
+
|
|
475
|
+
Gets the Connect failure log information.
|
|
476
|
+
|
|
477
|
+
Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.
|
|
478
|
+
|
|
479
|
+
### Example
|
|
480
|
+
```ruby
|
|
481
|
+
# load the gem
|
|
482
|
+
require 'docusign_esign'
|
|
483
|
+
|
|
484
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
485
|
+
|
|
486
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
487
|
+
|
|
488
|
+
opts = {
|
|
489
|
+
from_date: "from_date_example", # String |
|
|
490
|
+
to_date: "to_date_example" # String |
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
begin
|
|
494
|
+
#Gets the Connect failure log information.
|
|
495
|
+
result = api_instance.list_event_failure_logs(account_id, opts)
|
|
496
|
+
p result
|
|
497
|
+
rescue DocuSign_eSign::ApiError => e
|
|
498
|
+
puts "Exception when calling ConnectApi->list_event_failure_logs: #{e}"
|
|
499
|
+
end
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
### Parameters
|
|
503
|
+
|
|
504
|
+
Name | Type | Description | Notes
|
|
505
|
+
------------- | ------------- | ------------- | -------------
|
|
506
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
507
|
+
**from_date** | **String**| | [optional]
|
|
508
|
+
**to_date** | **String**| | [optional]
|
|
509
|
+
|
|
510
|
+
### Return type
|
|
511
|
+
|
|
512
|
+
[**ConnectLogs**](ConnectLogs.md)
|
|
513
|
+
|
|
514
|
+
### Authorization
|
|
515
|
+
|
|
516
|
+
No authorization required
|
|
517
|
+
|
|
518
|
+
### HTTP request headers
|
|
519
|
+
|
|
520
|
+
- **Content-Type**: Not defined
|
|
521
|
+
- **Accept**: application/json
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
# **list_event_logs**
|
|
526
|
+
> ConnectLogs list_event_logs(account_id, opts)
|
|
527
|
+
|
|
528
|
+
Gets the Connect log.
|
|
529
|
+
|
|
530
|
+
Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.
|
|
531
|
+
|
|
532
|
+
### Example
|
|
533
|
+
```ruby
|
|
534
|
+
# load the gem
|
|
535
|
+
require 'docusign_esign'
|
|
536
|
+
|
|
537
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
538
|
+
|
|
539
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
540
|
+
|
|
541
|
+
opts = {
|
|
542
|
+
from_date: "from_date_example", # String |
|
|
543
|
+
to_date: "to_date_example" # String |
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
begin
|
|
547
|
+
#Gets the Connect log.
|
|
548
|
+
result = api_instance.list_event_logs(account_id, opts)
|
|
549
|
+
p result
|
|
550
|
+
rescue DocuSign_eSign::ApiError => e
|
|
551
|
+
puts "Exception when calling ConnectApi->list_event_logs: #{e}"
|
|
552
|
+
end
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
### Parameters
|
|
556
|
+
|
|
557
|
+
Name | Type | Description | Notes
|
|
558
|
+
------------- | ------------- | ------------- | -------------
|
|
559
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
560
|
+
**from_date** | **String**| | [optional]
|
|
561
|
+
**to_date** | **String**| | [optional]
|
|
562
|
+
|
|
563
|
+
### Return type
|
|
564
|
+
|
|
565
|
+
[**ConnectLogs**](ConnectLogs.md)
|
|
566
|
+
|
|
567
|
+
### Authorization
|
|
568
|
+
|
|
569
|
+
No authorization required
|
|
570
|
+
|
|
571
|
+
### HTTP request headers
|
|
572
|
+
|
|
573
|
+
- **Content-Type**: Not defined
|
|
574
|
+
- **Accept**: application/json
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
# **list_mobile_notifiers**
|
|
579
|
+
> MobileNotifierConfigurationInformation list_mobile_notifiers(account_id)
|
|
580
|
+
|
|
581
|
+
Reserved
|
|
582
|
+
|
|
583
|
+
Reserved:
|
|
584
|
+
|
|
585
|
+
### Example
|
|
586
|
+
```ruby
|
|
587
|
+
# load the gem
|
|
588
|
+
require 'docusign_esign'
|
|
589
|
+
|
|
590
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
591
|
+
|
|
592
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
begin
|
|
596
|
+
#Reserved
|
|
597
|
+
result = api_instance.list_mobile_notifiers(account_id)
|
|
598
|
+
p result
|
|
599
|
+
rescue DocuSign_eSign::ApiError => e
|
|
600
|
+
puts "Exception when calling ConnectApi->list_mobile_notifiers: #{e}"
|
|
601
|
+
end
|
|
602
|
+
```
|
|
603
|
+
|
|
604
|
+
### Parameters
|
|
605
|
+
|
|
606
|
+
Name | Type | Description | Notes
|
|
607
|
+
------------- | ------------- | ------------- | -------------
|
|
608
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
609
|
+
|
|
610
|
+
### Return type
|
|
611
|
+
|
|
612
|
+
[**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)
|
|
613
|
+
|
|
614
|
+
### Authorization
|
|
615
|
+
|
|
616
|
+
No authorization required
|
|
617
|
+
|
|
618
|
+
### HTTP request headers
|
|
619
|
+
|
|
620
|
+
- **Content-Type**: Not defined
|
|
621
|
+
- **Accept**: application/json
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
# **list_users**
|
|
626
|
+
> IntegratedUserInfoList list_users(account_id, connect_id, opts)
|
|
627
|
+
|
|
628
|
+
Returns users from the configured Connect service.
|
|
629
|
+
|
|
630
|
+
Returns users from the configured Connect service.
|
|
631
|
+
|
|
632
|
+
### Example
|
|
633
|
+
```ruby
|
|
634
|
+
# load the gem
|
|
635
|
+
require 'docusign_esign'
|
|
636
|
+
|
|
637
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
638
|
+
|
|
639
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
640
|
+
|
|
641
|
+
connect_id = "connect_id_example" # String | The ID of the custom Connect configuration being accessed.
|
|
642
|
+
|
|
643
|
+
opts = {
|
|
644
|
+
count: "count_example", # String |
|
|
645
|
+
email_substring: "email_substring_example", # String |
|
|
646
|
+
list_included_users: "list_included_users_example", # String |
|
|
647
|
+
start_position: "start_position_example", # String |
|
|
648
|
+
status: "status_example", # String |
|
|
649
|
+
user_name_substring: "user_name_substring_example" # String |
|
|
650
|
+
}
|
|
651
|
+
|
|
652
|
+
begin
|
|
653
|
+
#Returns users from the configured Connect service.
|
|
654
|
+
result = api_instance.list_users(account_id, connect_id, opts)
|
|
655
|
+
p result
|
|
656
|
+
rescue DocuSign_eSign::ApiError => e
|
|
657
|
+
puts "Exception when calling ConnectApi->list_users: #{e}"
|
|
658
|
+
end
|
|
659
|
+
```
|
|
660
|
+
|
|
661
|
+
### Parameters
|
|
662
|
+
|
|
663
|
+
Name | Type | Description | Notes
|
|
664
|
+
------------- | ------------- | ------------- | -------------
|
|
665
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
666
|
+
**connect_id** | **String**| The ID of the custom Connect configuration being accessed. |
|
|
667
|
+
**count** | **String**| | [optional]
|
|
668
|
+
**email_substring** | **String**| | [optional]
|
|
669
|
+
**list_included_users** | **String**| | [optional]
|
|
670
|
+
**start_position** | **String**| | [optional]
|
|
671
|
+
**status** | **String**| | [optional]
|
|
672
|
+
**user_name_substring** | **String**| | [optional]
|
|
673
|
+
|
|
674
|
+
### Return type
|
|
675
|
+
|
|
676
|
+
[**IntegratedUserInfoList**](IntegratedUserInfoList.md)
|
|
677
|
+
|
|
678
|
+
### Authorization
|
|
679
|
+
|
|
680
|
+
No authorization required
|
|
681
|
+
|
|
682
|
+
### HTTP request headers
|
|
683
|
+
|
|
684
|
+
- **Content-Type**: Not defined
|
|
685
|
+
- **Accept**: application/json
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
# **retry_event_for_envelope**
|
|
690
|
+
> ConnectFailureResults retry_event_for_envelope(account_id, envelope_id)
|
|
691
|
+
|
|
692
|
+
Republishes Connect information for the specified envelope.
|
|
693
|
+
|
|
694
|
+
Republishes Connect information for the specified envelope.
|
|
695
|
+
|
|
696
|
+
### Example
|
|
697
|
+
```ruby
|
|
698
|
+
# load the gem
|
|
699
|
+
require 'docusign_esign'
|
|
700
|
+
|
|
701
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
702
|
+
|
|
703
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
704
|
+
|
|
705
|
+
envelope_id = "envelope_id_example" # String | The envelopeId Guid of the envelope being accessed.
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
begin
|
|
709
|
+
#Republishes Connect information for the specified envelope.
|
|
710
|
+
result = api_instance.retry_event_for_envelope(account_id, envelope_id)
|
|
711
|
+
p result
|
|
712
|
+
rescue DocuSign_eSign::ApiError => e
|
|
713
|
+
puts "Exception when calling ConnectApi->retry_event_for_envelope: #{e}"
|
|
714
|
+
end
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
### Parameters
|
|
718
|
+
|
|
719
|
+
Name | Type | Description | Notes
|
|
720
|
+
------------- | ------------- | ------------- | -------------
|
|
721
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
722
|
+
**envelope_id** | **String**| The envelopeId Guid of the envelope being accessed. |
|
|
723
|
+
|
|
724
|
+
### Return type
|
|
725
|
+
|
|
726
|
+
[**ConnectFailureResults**](ConnectFailureResults.md)
|
|
727
|
+
|
|
728
|
+
### Authorization
|
|
729
|
+
|
|
730
|
+
No authorization required
|
|
731
|
+
|
|
732
|
+
### HTTP request headers
|
|
733
|
+
|
|
734
|
+
- **Content-Type**: Not defined
|
|
735
|
+
- **Accept**: application/json
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
# **retry_event_for_envelopes**
|
|
740
|
+
> ConnectFailureResults retry_event_for_envelopes(account_id, opts)
|
|
741
|
+
|
|
742
|
+
Republishes Connect information for multiple envelopes.
|
|
743
|
+
|
|
744
|
+
Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log.
|
|
745
|
+
|
|
746
|
+
### Example
|
|
747
|
+
```ruby
|
|
748
|
+
# load the gem
|
|
749
|
+
require 'docusign_esign'
|
|
750
|
+
|
|
751
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
752
|
+
|
|
753
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
754
|
+
|
|
755
|
+
opts = {
|
|
756
|
+
connect_failure_filter: DocuSign_eSign::ConnectFailureFilter.new # ConnectFailureFilter |
|
|
757
|
+
}
|
|
758
|
+
|
|
759
|
+
begin
|
|
760
|
+
#Republishes Connect information for multiple envelopes.
|
|
761
|
+
result = api_instance.retry_event_for_envelopes(account_id, opts)
|
|
762
|
+
p result
|
|
763
|
+
rescue DocuSign_eSign::ApiError => e
|
|
764
|
+
puts "Exception when calling ConnectApi->retry_event_for_envelopes: #{e}"
|
|
765
|
+
end
|
|
766
|
+
```
|
|
767
|
+
|
|
768
|
+
### Parameters
|
|
769
|
+
|
|
770
|
+
Name | Type | Description | Notes
|
|
771
|
+
------------- | ------------- | ------------- | -------------
|
|
772
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
773
|
+
**connect_failure_filter** | [**ConnectFailureFilter**](ConnectFailureFilter.md)| | [optional]
|
|
774
|
+
|
|
775
|
+
### Return type
|
|
776
|
+
|
|
777
|
+
[**ConnectFailureResults**](ConnectFailureResults.md)
|
|
778
|
+
|
|
779
|
+
### Authorization
|
|
780
|
+
|
|
781
|
+
No authorization required
|
|
782
|
+
|
|
783
|
+
### HTTP request headers
|
|
784
|
+
|
|
785
|
+
- **Content-Type**: Not defined
|
|
786
|
+
- **Accept**: application/json
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
# **update_configuration**
|
|
791
|
+
> ConnectCustomConfiguration update_configuration(account_id, opts)
|
|
792
|
+
|
|
793
|
+
Updates a specified Connect configuration.
|
|
794
|
+
|
|
795
|
+
Updates the specified DocuSign Connect configuration in your account. ###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.
|
|
796
|
+
|
|
797
|
+
### Example
|
|
798
|
+
```ruby
|
|
799
|
+
# load the gem
|
|
800
|
+
require 'docusign_esign'
|
|
801
|
+
|
|
802
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
803
|
+
|
|
804
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
805
|
+
|
|
806
|
+
opts = {
|
|
807
|
+
connect_custom_configuration: DocuSign_eSign::ConnectCustomConfiguration.new # ConnectCustomConfiguration |
|
|
808
|
+
}
|
|
809
|
+
|
|
810
|
+
begin
|
|
811
|
+
#Updates a specified Connect configuration.
|
|
812
|
+
result = api_instance.update_configuration(account_id, opts)
|
|
813
|
+
p result
|
|
814
|
+
rescue DocuSign_eSign::ApiError => e
|
|
815
|
+
puts "Exception when calling ConnectApi->update_configuration: #{e}"
|
|
816
|
+
end
|
|
817
|
+
```
|
|
818
|
+
|
|
819
|
+
### Parameters
|
|
820
|
+
|
|
821
|
+
Name | Type | Description | Notes
|
|
822
|
+
------------- | ------------- | ------------- | -------------
|
|
823
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
824
|
+
**connect_custom_configuration** | [**ConnectCustomConfiguration**](ConnectCustomConfiguration.md)| | [optional]
|
|
825
|
+
|
|
826
|
+
### Return type
|
|
827
|
+
|
|
828
|
+
[**ConnectCustomConfiguration**](ConnectCustomConfiguration.md)
|
|
829
|
+
|
|
830
|
+
### Authorization
|
|
831
|
+
|
|
832
|
+
No authorization required
|
|
833
|
+
|
|
834
|
+
### HTTP request headers
|
|
835
|
+
|
|
836
|
+
- **Content-Type**: Not defined
|
|
837
|
+
- **Accept**: application/json
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
# **update_mobile_notifiers**
|
|
842
|
+
> MobileNotifierConfigurationInformation update_mobile_notifiers(account_id, opts)
|
|
843
|
+
|
|
844
|
+
Reserved
|
|
845
|
+
|
|
846
|
+
Reserved:
|
|
847
|
+
|
|
848
|
+
### Example
|
|
849
|
+
```ruby
|
|
850
|
+
# load the gem
|
|
851
|
+
require 'docusign_esign'
|
|
852
|
+
|
|
853
|
+
api_instance = DocuSign_eSign::ConnectApi.new
|
|
854
|
+
|
|
855
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
856
|
+
|
|
857
|
+
opts = {
|
|
858
|
+
mobile_notifier_configuration_information: DocuSign_eSign::MobileNotifierConfigurationInformation.new # MobileNotifierConfigurationInformation |
|
|
859
|
+
}
|
|
860
|
+
|
|
861
|
+
begin
|
|
862
|
+
#Reserved
|
|
863
|
+
result = api_instance.update_mobile_notifiers(account_id, opts)
|
|
864
|
+
p result
|
|
865
|
+
rescue DocuSign_eSign::ApiError => e
|
|
866
|
+
puts "Exception when calling ConnectApi->update_mobile_notifiers: #{e}"
|
|
867
|
+
end
|
|
868
|
+
```
|
|
869
|
+
|
|
870
|
+
### Parameters
|
|
871
|
+
|
|
872
|
+
Name | Type | Description | Notes
|
|
873
|
+
------------- | ------------- | ------------- | -------------
|
|
874
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
875
|
+
**mobile_notifier_configuration_information** | [**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)| | [optional]
|
|
876
|
+
|
|
877
|
+
### Return type
|
|
878
|
+
|
|
879
|
+
[**MobileNotifierConfigurationInformation**](MobileNotifierConfigurationInformation.md)
|
|
880
|
+
|
|
881
|
+
### Authorization
|
|
882
|
+
|
|
883
|
+
No authorization required
|
|
884
|
+
|
|
885
|
+
### HTTP request headers
|
|
886
|
+
|
|
887
|
+
- **Content-Type**: Not defined
|
|
888
|
+
- **Accept**: application/json
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
|