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::SocialAccountInformation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | The users email address. | [optional]
|
7
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
8
|
+
**provider** | **String** | The social account provider (Facebook, Yahoo, etc.) | [optional]
|
9
|
+
**social_id** | **String** | The ID provided by the Socal Account. | [optional]
|
10
|
+
**user_name** | **String** | The full user name for the account. | [optional]
|
11
|
+
|
12
|
+
|
data/docs/Ssn.md
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
# DocuSign_eSign::Ssn
|
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
|
+
**require_all** | **String** | When set to **true** and shared is true, information must be entered in this field to complete the envelope. | [optional]
|
34
|
+
**required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
|
35
|
+
**require_initial_on_shared_change** | **String** | Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. | [optional]
|
36
|
+
**sender_required** | **String** | When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. | [optional]
|
37
|
+
**shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
|
38
|
+
**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]
|
39
|
+
**tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
|
40
|
+
**tab_label** | **String** | The label string associated with the tab. | [optional]
|
41
|
+
**tab_order** | **String** | | [optional]
|
42
|
+
**template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
|
43
|
+
**template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
|
44
|
+
**underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
|
45
|
+
**validation_message** | **String** | The message displayed if the custom tab fails input validation (either custom of embedded). | [optional]
|
46
|
+
**validation_pattern** | **String** | A regular expressionn used to validate input for the tab. | [optional]
|
47
|
+
**value** | **String** | Specifies the value of the tab. | [optional]
|
48
|
+
**width** | **Integer** | Width of the tab in pixels. | [optional]
|
49
|
+
**x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
50
|
+
**y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
51
|
+
|
52
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# DocuSign_eSign::Ssn4InformationInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**display_level_code** | **String** | Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay | [optional]
|
7
|
+
**receive_in_response** | **String** | When set to **true**, the information needs to be returned in the response. | [optional]
|
8
|
+
**ssn4** | **String** | The last four digits of the recipient's Social Security Number (SSN). | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# DocuSign_eSign::Ssn9InformationInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**display_level_code** | **String** | Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay | [optional]
|
7
|
+
**ssn9** | **String** | The recipient's Social Security Number(SSN). | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# DocuSign_eSign::TabAccountSettings
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**allow_tab_order** | **String** | | [optional]
|
7
|
+
**allow_tab_order_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
8
|
+
**approve_decline_tabs_enabled** | **String** | | [optional]
|
9
|
+
**approve_decline_tabs_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
10
|
+
**calculated_fields_enabled** | **String** | | [optional]
|
11
|
+
**calculated_fields_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
12
|
+
**checkbox_tabs_enabled** | **String** | | [optional]
|
13
|
+
**checkbox_tabs_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
14
|
+
**data_field_regex_enabled** | **String** | | [optional]
|
15
|
+
**data_field_regex_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
16
|
+
**data_field_size_enabled** | **String** | | [optional]
|
17
|
+
**data_field_size_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
18
|
+
**first_last_email_tabs_enabled** | **String** | | [optional]
|
19
|
+
**first_last_email_tabs_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
20
|
+
**list_tabs_enabled** | **String** | | [optional]
|
21
|
+
**list_tabs_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
22
|
+
**note_tabs_enabled** | **String** | | [optional]
|
23
|
+
**note_tabs_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
24
|
+
**radio_tabs_enabled** | **String** | | [optional]
|
25
|
+
**radio_tabs_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
26
|
+
**saving_custom_tabs_enabled** | **String** | | [optional]
|
27
|
+
**saving_custom_tabs_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
28
|
+
**sender_to_change_tab_assignments_enabled** | **String** | | [optional]
|
29
|
+
**sender_to_change_tab_assignments_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
30
|
+
**shared_custom_tabs_enabled** | **String** | | [optional]
|
31
|
+
**shared_custom_tabs_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
32
|
+
**tab_data_label_enabled** | **String** | | [optional]
|
33
|
+
**tab_data_label_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
34
|
+
**tab_location_enabled** | **String** | | [optional]
|
35
|
+
**tab_location_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
36
|
+
**tab_locking_enabled** | **String** | | [optional]
|
37
|
+
**tab_locking_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
38
|
+
**tab_scale_enabled** | **String** | | [optional]
|
39
|
+
**tab_scale_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
40
|
+
**tab_text_formatting_enabled** | **String** | | [optional]
|
41
|
+
**tab_text_formatting_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
42
|
+
**text_tabs_enabled** | **String** | | [optional]
|
43
|
+
**text_tabs_metadata** | [**SettingsMetadata**](SettingsMetadata.md) | | [optional]
|
44
|
+
|
45
|
+
|
data/docs/TabMetadata.md
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
# DocuSign_eSign::TabMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**anchor** | **String** | An optional string that is used to auto-match tabs to strings located in the documents of an envelope. | [optional]
|
7
|
+
**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]
|
8
|
+
**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]
|
9
|
+
**anchor_ignore_if_not_present** | **String** | When set to **true**, this tab is ignored if anchorString is not found in the document. | [optional]
|
10
|
+
**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]
|
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
|
+
**created_by_display_name** | **String** | The user name of the DocuSign user who created this object. | [optional]
|
17
|
+
**created_by_user_id** | **String** | The userId of the DocuSign user who created this object. | [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
|
+
**editable** | **String** | When set to **true**, the custom tab is editable. Otherwise the custom tab cannot be modified. | [optional]
|
21
|
+
**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]
|
22
|
+
**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]
|
23
|
+
**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]
|
24
|
+
**height** | **String** | Height of the tab in pixels. | [optional]
|
25
|
+
**included_in_email** | **String** | When set to **true**, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs. | [optional]
|
26
|
+
**initial_value** | **String** | The original value of the tab. | [optional]
|
27
|
+
**italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
|
28
|
+
**items** | **Array<String>** | If the tab is a list, this represents the values that are possible for the tab. | [optional]
|
29
|
+
**last_modified** | **String** | The UTC DateTime this object was last modified. This is in ISO8601 format. | [optional]
|
30
|
+
**last_modified_by_display_name** | **String** | The User Name of the DocuSign user who last modified this object. | [optional]
|
31
|
+
**last_modified_by_user_id** | **String** | The userId of the DocuSign user who last modified this object. | [optional]
|
32
|
+
**locked** | **String** | When set to **true**, the signer cannot change the data of the custom tab. | [optional]
|
33
|
+
**maximum_length** | **String** | The maximum number of entry characters supported by the custom tab. | [optional]
|
34
|
+
**merge_field** | [**MergeField**](MergeField.md) | | [optional]
|
35
|
+
**name** | **String** | | [optional]
|
36
|
+
**required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
|
37
|
+
**scale_value** | **String** | | [optional]
|
38
|
+
**shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
|
39
|
+
**tab_label** | **String** | The label string associated with the tab. | [optional]
|
40
|
+
**type** | **String** | The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4. | [optional]
|
41
|
+
**underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
|
42
|
+
**validation_message** | **String** | The message displayed if the custom tab fails input validation (either custom of embedded). | [optional]
|
43
|
+
**validation_pattern** | **String** | A regular expressionn used to validate input for the tab. | [optional]
|
44
|
+
**width** | **String** | Width of the tab in pixels. | [optional]
|
45
|
+
|
46
|
+
|
data/docs/Tabs.md
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
# DocuSign_eSign::Tabs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**approve_tabs** | [**Array<Approve>**](Approve.md) | Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. | [optional]
|
7
|
+
**checkbox_tabs** | [**Array<Checkbox>**](Checkbox.md) | Specifies a tag on the document in a location where the recipient can select an option. | [optional]
|
8
|
+
**company_tabs** | [**Array<Company>**](Company.md) | Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
9
|
+
**date_signed_tabs** | [**Array<DateSigned>**](DateSigned.md) | Specifies a tab on the document where the date the document was signed will automatically appear. | [optional]
|
10
|
+
**date_tabs** | **Array<Date>** | Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. | [optional]
|
11
|
+
**decline_tabs** | [**Array<Decline>**](Decline.md) | Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. | [optional]
|
12
|
+
**email_address_tabs** | [**Array<EmailAddress>**](EmailAddress.md) | Specifies a location on the document where you want where you want the recipient’s email, as entered in the recipient information, to display. | [optional]
|
13
|
+
**email_tabs** | [**Array<Email>**](Email.md) | Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
14
|
+
**envelope_id_tabs** | [**Array<EnvelopeId>**](EnvelopeId.md) | Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. | [optional]
|
15
|
+
**first_name_tabs** | [**Array<FirstName>**](FirstName.md) | Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. | [optional]
|
16
|
+
**formula_tabs** | [**Array<FormulaTab>**](FormulaTab.md) | Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the \"formula\" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas. | [optional]
|
17
|
+
**full_name_tabs** | [**Array<FullName>**](FullName.md) | Specifies a tag on the document where you want the recipient's name to appear. | [optional]
|
18
|
+
**initial_here_tabs** | [**Array<InitialHere>**](InitialHere.md) | Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional. | [optional]
|
19
|
+
**last_name_tabs** | [**Array<LastName>**](LastName.md) | Specifies a tag on a document where you want the recipient’s last name to appear. This tag takes the recipient’s name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. | [optional]
|
20
|
+
**list_tabs** | [**Array<Array>**](List.md) | Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. | [optional]
|
21
|
+
**note_tabs** | [**Array<Note>**](Note.md) | Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient. | [optional]
|
22
|
+
**number_tabs** | [**Array<Number>**](Number.md) | Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
23
|
+
**radio_group_tabs** | [**Array<RadioGroup>**](RadioGroup.md) | Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. | [optional]
|
24
|
+
**signer_attachment_tabs** | [**Array<SignerAttachment>**](SignerAttachment.md) | Specifies a tag on the document when you want the recipient to add supporting documents to an envelope. | [optional]
|
25
|
+
**sign_here_tabs** | [**Array<SignHere>**](SignHere.md) | A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The \"optional\" parameter sets if the signature is required or optional. | [optional]
|
26
|
+
**ssn_tabs** | [**Array<Ssn>**](Ssn.md) | Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
27
|
+
**text_tabs** | [**Array<Text>**](Text.md) | Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
28
|
+
**title_tabs** | [**Array<Title>**](Title.md) | Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
29
|
+
**view_tabs** | [**Array<View>**](View.md) | | [optional]
|
30
|
+
**zip_tabs** | [**Array<Zip>**](Zip.md) | Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
31
|
+
|
32
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# DocuSign_eSign::TemplateCustomFields
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**list_custom_fields** | [**Array<ListCustomField>**](ListCustomField.md) | An array of list custom fields. | [optional]
|
7
|
+
**text_custom_fields** | [**Array<TextCustomField>**](TextCustomField.md) | An array of text custom fields. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# DocuSign_eSign::TemplateDocumentVisibilityList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**document_visibility** | [**Array<DocumentVisibility>**](DocumentVisibility.md) | | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# DocuSign_eSign::TemplateDocumentsResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**template_documents** | [**Array<EnvelopeDocument>**](EnvelopeDocument.md) | | [optional]
|
7
|
+
**template_id** | **String** | The unique identifier of the template. If this is not provided, DocuSign will generate a value. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# DocuSign_eSign::TemplateMatch
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**document_end_page** | **String** | | [optional]
|
7
|
+
**document_start_page** | **String** | | [optional]
|
8
|
+
**match_percentage** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# DocuSign_eSign::TemplateNotificationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**expirations** | [**Expirations**](Expirations.md) | | [optional]
|
7
|
+
**password** | **String** | | [optional]
|
8
|
+
**reminders** | [**Reminders**](Reminders.md) | | [optional]
|
9
|
+
**use_account_defaults** | **String** | When set to **true**, the account default notification settings are used for the envelope. | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# DocuSign_eSign::TemplateRecipients
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**agents** | [**Array<Agent>**](Agent.md) | A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. | [optional]
|
7
|
+
**carbon_copies** | [**Array<CarbonCopy>**](CarbonCopy.md) | A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. | [optional]
|
8
|
+
**certified_deliveries** | [**Array<CertifiedDelivery>**](CertifiedDelivery.md) | A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. | [optional]
|
9
|
+
**current_routing_order** | **String** | | [optional]
|
10
|
+
**editors** | [**Array<Editor>**](Editor.md) | | [optional]
|
11
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
12
|
+
**in_person_signers** | [**Array<InPersonSigner>**](InPersonSigner.md) | Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. | [optional]
|
13
|
+
**intermediaries** | [**Array<Intermediary>**](Intermediary.md) | Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). | [optional]
|
14
|
+
**recipient_count** | **String** | The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message. | [optional]
|
15
|
+
**signers** | [**Array<Signer>**](Signer.md) | A complex type containing information about the Signer recipient. | [optional]
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# DocuSign_eSign::TemplateRole
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**access_code** | **String** | If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. | [optional]
|
7
|
+
**client_user_id** | **String** | Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. | [optional]
|
8
|
+
**default_recipient** | **String** | When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. | [optional]
|
9
|
+
**email** | **String** | Specifies the email associated with a role name. | [optional]
|
10
|
+
**email_notification** | [**RecipientEmailNotification**](RecipientEmailNotification.md) | | [optional]
|
11
|
+
**embedded_recipient_start_url** | **String** | Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` | [optional]
|
12
|
+
**in_person_signer_name** | **String** | Specifies the full legal name of the signer in person signer template roles. Maximum Length: 100 characters. | [optional]
|
13
|
+
**name** | **String** | Specifies the recipient's name. | [optional]
|
14
|
+
**role_name** | **String** | Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. | [optional]
|
15
|
+
**routing_order** | **String** | Specifies the routing order of the recipient in the envelope. | [optional]
|
16
|
+
**signing_group_id** | **String** | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). | [optional]
|
17
|
+
**tabs** | [**Tabs**](Tabs.md) | | [optional]
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# DocuSign_eSign::TemplateSharedItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
7
|
+
**owner** | [**UserInfo**](UserInfo.md) | | [optional]
|
8
|
+
**shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
|
9
|
+
**shared_groups** | [**Array<MemberGroupSharedItem>**](MemberGroupSharedItem.md) | | [optional]
|
10
|
+
**shared_users** | [**Array<UserSharedItem>**](UserSharedItem.md) | | [optional]
|
11
|
+
**template_id** | **String** | The unique identifier of the template. If this is not provided, DocuSign will generate a value. | [optional]
|
12
|
+
**template_name** | **String** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# DocuSign_eSign::TemplateSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**applied** | **String** | Reserved: TBD | [optional]
|
7
|
+
**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]
|
8
|
+
**document_name** | **String** | | [optional]
|
9
|
+
**name** | **String** | | [optional]
|
10
|
+
**template_id** | **String** | The unique identifier of the template. If this is not provided, DocuSign will generate a value. | [optional]
|
11
|
+
**template_match** | [**TemplateMatch**](TemplateMatch.md) | | [optional]
|
12
|
+
**uri** | **String** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# DocuSign_eSign::TemplateTabs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**approve_tabs** | [**Array<Approve>**](Approve.md) | Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. | [optional]
|
7
|
+
**checkbox_tabs** | [**Array<Checkbox>**](Checkbox.md) | Specifies a tag on the document in a location where the recipient can select an option. | [optional]
|
8
|
+
**company_tabs** | [**Array<Company>**](Company.md) | Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
9
|
+
**date_signed_tabs** | [**Array<DateSigned>**](DateSigned.md) | Specifies a tab on the document where the date the document was signed will automatically appear. | [optional]
|
10
|
+
**date_tabs** | **Array<Date>** | Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. | [optional]
|
11
|
+
**decline_tabs** | [**Array<Decline>**](Decline.md) | Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. | [optional]
|
12
|
+
**email_address_tabs** | [**Array<EmailAddress>**](EmailAddress.md) | Specifies a location on the document where you want where you want the recipient’s email, as entered in the recipient information, to display. | [optional]
|
13
|
+
**email_tabs** | [**Array<Email>**](Email.md) | Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
14
|
+
**envelope_id_tabs** | [**Array<EnvelopeId>**](EnvelopeId.md) | Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. | [optional]
|
15
|
+
**first_name_tabs** | [**Array<FirstName>**](FirstName.md) | Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. | [optional]
|
16
|
+
**formula_tabs** | [**Array<FormulaTab>**](FormulaTab.md) | Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the \"formula\" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas. | [optional]
|
17
|
+
**full_name_tabs** | [**Array<FullName>**](FullName.md) | Specifies a tag on the document where you want the recipient's name to appear. | [optional]
|
18
|
+
**initial_here_tabs** | [**Array<InitialHere>**](InitialHere.md) | Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional. | [optional]
|
19
|
+
**last_name_tabs** | [**Array<LastName>**](LastName.md) | Specifies a tag on a document where you want the recipient’s last name to appear. This tag takes the recipient’s name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. | [optional]
|
20
|
+
**list_tabs** | [**Array<Array>**](List.md) | Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. | [optional]
|
21
|
+
**note_tabs** | [**Array<Note>**](Note.md) | Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient. | [optional]
|
22
|
+
**number_tabs** | [**Array<Number>**](Number.md) | Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
23
|
+
**radio_group_tabs** | [**Array<RadioGroup>**](RadioGroup.md) | Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. | [optional]
|
24
|
+
**signer_attachment_tabs** | [**Array<SignerAttachment>**](SignerAttachment.md) | Specifies a tag on the document when you want the recipient to add supporting documents to an envelope. | [optional]
|
25
|
+
**sign_here_tabs** | [**Array<SignHere>**](SignHere.md) | A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The \"optional\" parameter sets if the signature is required or optional. | [optional]
|
26
|
+
**ssn_tabs** | [**Array<Ssn>**](Ssn.md) | Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
27
|
+
**text_tabs** | [**Array<Text>**](Text.md) | Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
28
|
+
**title_tabs** | [**Array<Title>**](Title.md) | Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
29
|
+
**view_tabs** | [**Array<View>**](View.md) | | [optional]
|
30
|
+
**zip_tabs** | [**Array<Zip>**](Zip.md) | Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. | [optional]
|
31
|
+
|
32
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# DocuSign_eSign::TemplateUpdateSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**bulk_envelope_status** | [**BulkEnvelopeStatus**](BulkEnvelopeStatus.md) | | [optional]
|
7
|
+
**envelope_id** | **String** | The envelope ID of the envelope status that failed to post. | [optional]
|
8
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
9
|
+
**list_custom_field_update_results** | [**Array<ListCustomField>**](ListCustomField.md) | | [optional]
|
10
|
+
**lock_information** | [**LockInformation**](LockInformation.md) | | [optional]
|
11
|
+
**recipient_update_results** | [**Array<RecipientUpdateResponse>**](RecipientUpdateResponse.md) | | [optional]
|
12
|
+
**tab_update_results** | [**Tabs**](Tabs.md) | | [optional]
|
13
|
+
**text_custom_field_update_results** | [**Array<TextCustomField>**](TextCustomField.md) | | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,2349 @@
|
|
1
|
+
# DocuSign_eSign::TemplatesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://www.docusign.net/restapi*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create_custom_fields**](TemplatesApi.md#create_custom_fields) | **POST** /v2/accounts/{accountId}/templates/{templateId}/custom_fields | Creates custom document fields in an existing template document.
|
8
|
+
[**create_document_fields**](TemplatesApi.md#create_document_fields) | **POST** /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields | Creates custom document fields in an existing template document.
|
9
|
+
[**create_edit_view**](TemplatesApi.md#create_edit_view) | **POST** /v2/accounts/{accountId}/templates/{templateId}/views/edit | Provides a URL to start an edit view of the Template UI
|
10
|
+
[**create_lock**](TemplatesApi.md#create_lock) | **POST** /v2/accounts/{accountId}/templates/{templateId}/lock | Lock a template.
|
11
|
+
[**create_recipients**](TemplatesApi.md#create_recipients) | **POST** /v2/accounts/{accountId}/templates/{templateId}/recipients | Adds tabs for a recipient.
|
12
|
+
[**create_tabs**](TemplatesApi.md#create_tabs) | **POST** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs | Adds tabs for a recipient.
|
13
|
+
[**create_template**](TemplatesApi.md#create_template) | **POST** /v2/accounts/{accountId}/templates | Creates an envelope from a template.
|
14
|
+
[**delete_bulk_recipients**](TemplatesApi.md#delete_bulk_recipients) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients | Deletes the bulk recipient list on a template.
|
15
|
+
[**delete_custom_fields**](TemplatesApi.md#delete_custom_fields) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/custom_fields | Deletes envelope custom fields in a template.
|
16
|
+
[**delete_document_fields**](TemplatesApi.md#delete_document_fields) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields | Deletes custom document fields from an existing template document.
|
17
|
+
[**delete_document_page**](TemplatesApi.md#delete_document_page) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber} | Deletes a page from a document in an template.
|
18
|
+
[**delete_documents**](TemplatesApi.md#delete_documents) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/documents | Deletes documents from a template.
|
19
|
+
[**delete_group_share**](TemplatesApi.md#delete_group_share) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/{templatePart} | Removes a member group's sharing permissions for a template.
|
20
|
+
[**delete_lock**](TemplatesApi.md#delete_lock) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/lock | Deletes a template lock.
|
21
|
+
[**delete_recipient**](TemplatesApi.md#delete_recipient) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId} | Deletes the specified recipient file from a template.
|
22
|
+
[**delete_recipients**](TemplatesApi.md#delete_recipients) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/recipients | Deletes recipients from a template.
|
23
|
+
[**delete_tabs**](TemplatesApi.md#delete_tabs) | **DELETE** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs | Deletes the tabs associated with a recipient in a template.
|
24
|
+
[**get**](TemplatesApi.md#get) | **GET** /v2/accounts/{accountId}/templates/{templateId} | Gets a list of templates for a specified account.
|
25
|
+
[**get_document**](TemplatesApi.md#get_document) | **GET** /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId} | Gets PDF documents from a template.
|
26
|
+
[**get_document_page_image**](TemplatesApi.md#get_document_page_image) | **GET** /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image | Gets a page image from a template for display.
|
27
|
+
[**get_lock**](TemplatesApi.md#get_lock) | **GET** /v2/accounts/{accountId}/templates/{templateId}/lock | Gets template lock information.
|
28
|
+
[**get_notification_settings**](TemplatesApi.md#get_notification_settings) | **GET** /v2/accounts/{accountId}/templates/{templateId}/notification | Gets template notification information.
|
29
|
+
[**list_bulk_recipients**](TemplatesApi.md#list_bulk_recipients) | **GET** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients | Gets the bulk recipient file from a template.
|
30
|
+
[**list_custom_fields**](TemplatesApi.md#list_custom_fields) | **GET** /v2/accounts/{accountId}/templates/{templateId}/custom_fields | Gets the custom document fields from a template.
|
31
|
+
[**list_document_fields**](TemplatesApi.md#list_document_fields) | **GET** /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields | Gets the custom document fields for a an existing template document.
|
32
|
+
[**list_documents**](TemplatesApi.md#list_documents) | **GET** /v2/accounts/{accountId}/templates/{templateId}/documents | Gets a list of documents associated with a template.
|
33
|
+
[**list_recipients**](TemplatesApi.md#list_recipients) | **GET** /v2/accounts/{accountId}/templates/{templateId}/recipients | Gets recipient information from a template.
|
34
|
+
[**list_tabs**](TemplatesApi.md#list_tabs) | **GET** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs | Gets the tabs information for a signer or sign-in-person recipient in a template.
|
35
|
+
[**list_templates**](TemplatesApi.md#list_templates) | **GET** /v2/accounts/{accountId}/templates | Gets the definition of a template.
|
36
|
+
[**rotate_document_page**](TemplatesApi.md#rotate_document_page) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image | Rotates page image from a template for display.
|
37
|
+
[**update**](TemplatesApi.md#update) | **PUT** /v2/accounts/{accountId}/templates/{templateId} | Updates an existing template.
|
38
|
+
[**update_bulk_recipients**](TemplatesApi.md#update_bulk_recipients) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients | Adds or replaces the bulk recipients list in a template.
|
39
|
+
[**update_custom_fields**](TemplatesApi.md#update_custom_fields) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/custom_fields | Updates envelope custom fields in a template.
|
40
|
+
[**update_document**](TemplatesApi.md#update_document) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId} | Adds a document to a template document.
|
41
|
+
[**update_document_fields**](TemplatesApi.md#update_document_fields) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields | Updates existing custom document fields in an existing template document.
|
42
|
+
[**update_documents**](TemplatesApi.md#update_documents) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/documents | Adds documents to a template document.
|
43
|
+
[**update_group_share**](TemplatesApi.md#update_group_share) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/{templatePart} | Shares a template with a group
|
44
|
+
[**update_lock**](TemplatesApi.md#update_lock) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/lock | Updates a template lock.
|
45
|
+
[**update_notification_settings**](TemplatesApi.md#update_notification_settings) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/notification | Updates the notification structure for an existing template.
|
46
|
+
[**update_recipients**](TemplatesApi.md#update_recipients) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/recipients | Updates recipients in a template.
|
47
|
+
[**update_tabs**](TemplatesApi.md#update_tabs) | **PUT** /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs | Updates the tabs for a recipient.
|
48
|
+
|
49
|
+
|
50
|
+
# **create_custom_fields**
|
51
|
+
> CustomFields create_custom_fields(account_id, template_id, opts)
|
52
|
+
|
53
|
+
Creates custom document fields in an existing template document.
|
54
|
+
|
55
|
+
Creates custom document fields in an existing template document.
|
56
|
+
|
57
|
+
### Example
|
58
|
+
```ruby
|
59
|
+
# load the gem
|
60
|
+
require 'docusign_esign'
|
61
|
+
|
62
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
63
|
+
|
64
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
65
|
+
|
66
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
67
|
+
|
68
|
+
opts = {
|
69
|
+
template_custom_fields: DocuSign_eSign::TemplateCustomFields.new # TemplateCustomFields |
|
70
|
+
}
|
71
|
+
|
72
|
+
begin
|
73
|
+
#Creates custom document fields in an existing template document.
|
74
|
+
result = api_instance.create_custom_fields(account_id, template_id, opts)
|
75
|
+
p result
|
76
|
+
rescue DocuSign_eSign::ApiError => e
|
77
|
+
puts "Exception when calling TemplatesApi->create_custom_fields: #{e}"
|
78
|
+
end
|
79
|
+
```
|
80
|
+
|
81
|
+
### Parameters
|
82
|
+
|
83
|
+
Name | Type | Description | Notes
|
84
|
+
------------- | ------------- | ------------- | -------------
|
85
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
86
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
87
|
+
**template_custom_fields** | [**TemplateCustomFields**](TemplateCustomFields.md)| | [optional]
|
88
|
+
|
89
|
+
### Return type
|
90
|
+
|
91
|
+
[**CustomFields**](CustomFields.md)
|
92
|
+
|
93
|
+
### Authorization
|
94
|
+
|
95
|
+
No authorization required
|
96
|
+
|
97
|
+
### HTTP request headers
|
98
|
+
|
99
|
+
- **Content-Type**: Not defined
|
100
|
+
- **Accept**: application/json
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
# **create_document_fields**
|
105
|
+
> DocumentFieldsInformation create_document_fields(account_id, document_id, template_id, opts)
|
106
|
+
|
107
|
+
Creates custom document fields in an existing template document.
|
108
|
+
|
109
|
+
Creates custom document fields in an existing template document.
|
110
|
+
|
111
|
+
### Example
|
112
|
+
```ruby
|
113
|
+
# load the gem
|
114
|
+
require 'docusign_esign'
|
115
|
+
|
116
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
117
|
+
|
118
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
119
|
+
|
120
|
+
document_id = "document_id_example" # String | The ID of the document being accessed.
|
121
|
+
|
122
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
123
|
+
|
124
|
+
opts = {
|
125
|
+
document_fields_information: DocuSign_eSign::DocumentFieldsInformation.new # DocumentFieldsInformation |
|
126
|
+
}
|
127
|
+
|
128
|
+
begin
|
129
|
+
#Creates custom document fields in an existing template document.
|
130
|
+
result = api_instance.create_document_fields(account_id, document_id, template_id, opts)
|
131
|
+
p result
|
132
|
+
rescue DocuSign_eSign::ApiError => e
|
133
|
+
puts "Exception when calling TemplatesApi->create_document_fields: #{e}"
|
134
|
+
end
|
135
|
+
```
|
136
|
+
|
137
|
+
### Parameters
|
138
|
+
|
139
|
+
Name | Type | Description | Notes
|
140
|
+
------------- | ------------- | ------------- | -------------
|
141
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
142
|
+
**document_id** | **String**| The ID of the document being accessed. |
|
143
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
144
|
+
**document_fields_information** | [**DocumentFieldsInformation**](DocumentFieldsInformation.md)| | [optional]
|
145
|
+
|
146
|
+
### Return type
|
147
|
+
|
148
|
+
[**DocumentFieldsInformation**](DocumentFieldsInformation.md)
|
149
|
+
|
150
|
+
### Authorization
|
151
|
+
|
152
|
+
No authorization required
|
153
|
+
|
154
|
+
### HTTP request headers
|
155
|
+
|
156
|
+
- **Content-Type**: Not defined
|
157
|
+
- **Accept**: application/json
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
# **create_edit_view**
|
162
|
+
> ViewUrl create_edit_view(account_id, template_id, opts)
|
163
|
+
|
164
|
+
Provides a URL to start an edit view of the Template UI
|
165
|
+
|
166
|
+
### Example
|
167
|
+
```ruby
|
168
|
+
# load the gem
|
169
|
+
require 'docusign_esign'
|
170
|
+
|
171
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
172
|
+
|
173
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
174
|
+
|
175
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
176
|
+
|
177
|
+
opts = {
|
178
|
+
return_url_request: DocuSign_eSign::ReturnUrlRequest.new # ReturnUrlRequest |
|
179
|
+
}
|
180
|
+
|
181
|
+
begin
|
182
|
+
#Provides a URL to start an edit view of the Template UI
|
183
|
+
result = api_instance.create_edit_view(account_id, template_id, opts)
|
184
|
+
p result
|
185
|
+
rescue DocuSign_eSign::ApiError => e
|
186
|
+
puts "Exception when calling TemplatesApi->create_edit_view: #{e}"
|
187
|
+
end
|
188
|
+
```
|
189
|
+
|
190
|
+
### Parameters
|
191
|
+
|
192
|
+
Name | Type | Description | Notes
|
193
|
+
------------- | ------------- | ------------- | -------------
|
194
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
195
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
196
|
+
**return_url_request** | [**ReturnUrlRequest**](ReturnUrlRequest.md)| | [optional]
|
197
|
+
|
198
|
+
### Return type
|
199
|
+
|
200
|
+
[**ViewUrl**](ViewUrl.md)
|
201
|
+
|
202
|
+
### Authorization
|
203
|
+
|
204
|
+
No authorization required
|
205
|
+
|
206
|
+
### HTTP request headers
|
207
|
+
|
208
|
+
- **Content-Type**: Not defined
|
209
|
+
- **Accept**: application/json
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
# **create_lock**
|
214
|
+
> LockInformation create_lock(account_id, template_id, opts)
|
215
|
+
|
216
|
+
Lock a template.
|
217
|
+
|
218
|
+
Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to **true** for the user).
|
219
|
+
|
220
|
+
### Example
|
221
|
+
```ruby
|
222
|
+
# load the gem
|
223
|
+
require 'docusign_esign'
|
224
|
+
|
225
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
226
|
+
|
227
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
228
|
+
|
229
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
230
|
+
|
231
|
+
opts = {
|
232
|
+
lock_request: DocuSign_eSign::LockRequest.new # LockRequest |
|
233
|
+
}
|
234
|
+
|
235
|
+
begin
|
236
|
+
#Lock a template.
|
237
|
+
result = api_instance.create_lock(account_id, template_id, opts)
|
238
|
+
p result
|
239
|
+
rescue DocuSign_eSign::ApiError => e
|
240
|
+
puts "Exception when calling TemplatesApi->create_lock: #{e}"
|
241
|
+
end
|
242
|
+
```
|
243
|
+
|
244
|
+
### Parameters
|
245
|
+
|
246
|
+
Name | Type | Description | Notes
|
247
|
+
------------- | ------------- | ------------- | -------------
|
248
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
249
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
250
|
+
**lock_request** | [**LockRequest**](LockRequest.md)| | [optional]
|
251
|
+
|
252
|
+
### Return type
|
253
|
+
|
254
|
+
[**LockInformation**](LockInformation.md)
|
255
|
+
|
256
|
+
### Authorization
|
257
|
+
|
258
|
+
No authorization required
|
259
|
+
|
260
|
+
### HTTP request headers
|
261
|
+
|
262
|
+
- **Content-Type**: Not defined
|
263
|
+
- **Accept**: application/json
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
# **create_recipients**
|
268
|
+
> Recipients create_recipients(account_id, template_id, opts)
|
269
|
+
|
270
|
+
Adds tabs for a recipient.
|
271
|
+
|
272
|
+
Adds one or more recipients to a template.
|
273
|
+
|
274
|
+
### Example
|
275
|
+
```ruby
|
276
|
+
# load the gem
|
277
|
+
require 'docusign_esign'
|
278
|
+
|
279
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
280
|
+
|
281
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
282
|
+
|
283
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
284
|
+
|
285
|
+
opts = {
|
286
|
+
resend_envelope: "resend_envelope_example", # String |
|
287
|
+
template_recipients: DocuSign_eSign::TemplateRecipients.new # TemplateRecipients |
|
288
|
+
}
|
289
|
+
|
290
|
+
begin
|
291
|
+
#Adds tabs for a recipient.
|
292
|
+
result = api_instance.create_recipients(account_id, template_id, opts)
|
293
|
+
p result
|
294
|
+
rescue DocuSign_eSign::ApiError => e
|
295
|
+
puts "Exception when calling TemplatesApi->create_recipients: #{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
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
305
|
+
**resend_envelope** | **String**| | [optional]
|
306
|
+
**template_recipients** | [**TemplateRecipients**](TemplateRecipients.md)| | [optional]
|
307
|
+
|
308
|
+
### Return type
|
309
|
+
|
310
|
+
[**Recipients**](Recipients.md)
|
311
|
+
|
312
|
+
### Authorization
|
313
|
+
|
314
|
+
No authorization required
|
315
|
+
|
316
|
+
### HTTP request headers
|
317
|
+
|
318
|
+
- **Content-Type**: Not defined
|
319
|
+
- **Accept**: application/json
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
# **create_tabs**
|
324
|
+
> Tabs create_tabs(account_id, recipient_id, template_id, opts)
|
325
|
+
|
326
|
+
Adds tabs for a recipient.
|
327
|
+
|
328
|
+
Adds one or more tabs for a recipient.
|
329
|
+
|
330
|
+
### Example
|
331
|
+
```ruby
|
332
|
+
# load the gem
|
333
|
+
require 'docusign_esign'
|
334
|
+
|
335
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
336
|
+
|
337
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
338
|
+
|
339
|
+
recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
|
340
|
+
|
341
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
342
|
+
|
343
|
+
opts = {
|
344
|
+
template_tabs: DocuSign_eSign::TemplateTabs.new # TemplateTabs |
|
345
|
+
}
|
346
|
+
|
347
|
+
begin
|
348
|
+
#Adds tabs for a recipient.
|
349
|
+
result = api_instance.create_tabs(account_id, recipient_id, template_id, opts)
|
350
|
+
p result
|
351
|
+
rescue DocuSign_eSign::ApiError => e
|
352
|
+
puts "Exception when calling TemplatesApi->create_tabs: #{e}"
|
353
|
+
end
|
354
|
+
```
|
355
|
+
|
356
|
+
### Parameters
|
357
|
+
|
358
|
+
Name | Type | Description | Notes
|
359
|
+
------------- | ------------- | ------------- | -------------
|
360
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
361
|
+
**recipient_id** | **String**| The ID of the recipient being accessed. |
|
362
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
363
|
+
**template_tabs** | [**TemplateTabs**](TemplateTabs.md)| | [optional]
|
364
|
+
|
365
|
+
### Return type
|
366
|
+
|
367
|
+
[**Tabs**](Tabs.md)
|
368
|
+
|
369
|
+
### Authorization
|
370
|
+
|
371
|
+
No authorization required
|
372
|
+
|
373
|
+
### HTTP request headers
|
374
|
+
|
375
|
+
- **Content-Type**: Not defined
|
376
|
+
- **Accept**: application/json
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
# **create_template**
|
381
|
+
> TemplateSummary create_template(account_id, opts)
|
382
|
+
|
383
|
+
Creates an envelope from a template.
|
384
|
+
|
385
|
+
Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient’s role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient’s name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",` To add a recipient’s email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.
|
386
|
+
|
387
|
+
### Example
|
388
|
+
```ruby
|
389
|
+
# load the gem
|
390
|
+
require 'docusign_esign'
|
391
|
+
|
392
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
393
|
+
|
394
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
395
|
+
|
396
|
+
opts = {
|
397
|
+
envelope_template: DocuSign_eSign::EnvelopeTemplate.new # EnvelopeTemplate |
|
398
|
+
}
|
399
|
+
|
400
|
+
begin
|
401
|
+
#Creates an envelope from a template.
|
402
|
+
result = api_instance.create_template(account_id, opts)
|
403
|
+
p result
|
404
|
+
rescue DocuSign_eSign::ApiError => e
|
405
|
+
puts "Exception when calling TemplatesApi->create_template: #{e}"
|
406
|
+
end
|
407
|
+
```
|
408
|
+
|
409
|
+
### Parameters
|
410
|
+
|
411
|
+
Name | Type | Description | Notes
|
412
|
+
------------- | ------------- | ------------- | -------------
|
413
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
414
|
+
**envelope_template** | [**EnvelopeTemplate**](EnvelopeTemplate.md)| | [optional]
|
415
|
+
|
416
|
+
### Return type
|
417
|
+
|
418
|
+
[**TemplateSummary**](TemplateSummary.md)
|
419
|
+
|
420
|
+
### Authorization
|
421
|
+
|
422
|
+
No authorization required
|
423
|
+
|
424
|
+
### HTTP request headers
|
425
|
+
|
426
|
+
- **Content-Type**: Not defined
|
427
|
+
- **Accept**: application/json
|
428
|
+
|
429
|
+
|
430
|
+
|
431
|
+
# **delete_bulk_recipients**
|
432
|
+
> BulkRecipientsUpdateResponse delete_bulk_recipients(account_id, recipient_id, template_id)
|
433
|
+
|
434
|
+
Deletes the bulk recipient list on a template.
|
435
|
+
|
436
|
+
Deletes the bulk recipient list on a template.
|
437
|
+
|
438
|
+
### Example
|
439
|
+
```ruby
|
440
|
+
# load the gem
|
441
|
+
require 'docusign_esign'
|
442
|
+
|
443
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
444
|
+
|
445
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
446
|
+
|
447
|
+
recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
|
448
|
+
|
449
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
450
|
+
|
451
|
+
|
452
|
+
begin
|
453
|
+
#Deletes the bulk recipient list on a template.
|
454
|
+
result = api_instance.delete_bulk_recipients(account_id, recipient_id, template_id)
|
455
|
+
p result
|
456
|
+
rescue DocuSign_eSign::ApiError => e
|
457
|
+
puts "Exception when calling TemplatesApi->delete_bulk_recipients: #{e}"
|
458
|
+
end
|
459
|
+
```
|
460
|
+
|
461
|
+
### Parameters
|
462
|
+
|
463
|
+
Name | Type | Description | Notes
|
464
|
+
------------- | ------------- | ------------- | -------------
|
465
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
466
|
+
**recipient_id** | **String**| The ID of the recipient being accessed. |
|
467
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
468
|
+
|
469
|
+
### Return type
|
470
|
+
|
471
|
+
[**BulkRecipientsUpdateResponse**](BulkRecipientsUpdateResponse.md)
|
472
|
+
|
473
|
+
### Authorization
|
474
|
+
|
475
|
+
No authorization required
|
476
|
+
|
477
|
+
### HTTP request headers
|
478
|
+
|
479
|
+
- **Content-Type**: Not defined
|
480
|
+
- **Accept**: application/json
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
# **delete_custom_fields**
|
485
|
+
> CustomFields delete_custom_fields(account_id, template_id, opts)
|
486
|
+
|
487
|
+
Deletes envelope custom fields in a template.
|
488
|
+
|
489
|
+
Deletes envelope custom fields in a template.
|
490
|
+
|
491
|
+
### Example
|
492
|
+
```ruby
|
493
|
+
# load the gem
|
494
|
+
require 'docusign_esign'
|
495
|
+
|
496
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
497
|
+
|
498
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
499
|
+
|
500
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
501
|
+
|
502
|
+
opts = {
|
503
|
+
template_custom_fields: DocuSign_eSign::TemplateCustomFields.new # TemplateCustomFields |
|
504
|
+
}
|
505
|
+
|
506
|
+
begin
|
507
|
+
#Deletes envelope custom fields in a template.
|
508
|
+
result = api_instance.delete_custom_fields(account_id, template_id, opts)
|
509
|
+
p result
|
510
|
+
rescue DocuSign_eSign::ApiError => e
|
511
|
+
puts "Exception when calling TemplatesApi->delete_custom_fields: #{e}"
|
512
|
+
end
|
513
|
+
```
|
514
|
+
|
515
|
+
### Parameters
|
516
|
+
|
517
|
+
Name | Type | Description | Notes
|
518
|
+
------------- | ------------- | ------------- | -------------
|
519
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
520
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
521
|
+
**template_custom_fields** | [**TemplateCustomFields**](TemplateCustomFields.md)| | [optional]
|
522
|
+
|
523
|
+
### Return type
|
524
|
+
|
525
|
+
[**CustomFields**](CustomFields.md)
|
526
|
+
|
527
|
+
### Authorization
|
528
|
+
|
529
|
+
No authorization required
|
530
|
+
|
531
|
+
### HTTP request headers
|
532
|
+
|
533
|
+
- **Content-Type**: Not defined
|
534
|
+
- **Accept**: application/json
|
535
|
+
|
536
|
+
|
537
|
+
|
538
|
+
# **delete_document_fields**
|
539
|
+
> DocumentFieldsInformation delete_document_fields(account_id, document_id, template_id, opts)
|
540
|
+
|
541
|
+
Deletes custom document fields from an existing template document.
|
542
|
+
|
543
|
+
Deletes custom document fields from an existing template document.
|
544
|
+
|
545
|
+
### Example
|
546
|
+
```ruby
|
547
|
+
# load the gem
|
548
|
+
require 'docusign_esign'
|
549
|
+
|
550
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
551
|
+
|
552
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
553
|
+
|
554
|
+
document_id = "document_id_example" # String | The ID of the document being accessed.
|
555
|
+
|
556
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
557
|
+
|
558
|
+
opts = {
|
559
|
+
document_fields_information: DocuSign_eSign::DocumentFieldsInformation.new # DocumentFieldsInformation |
|
560
|
+
}
|
561
|
+
|
562
|
+
begin
|
563
|
+
#Deletes custom document fields from an existing template document.
|
564
|
+
result = api_instance.delete_document_fields(account_id, document_id, template_id, opts)
|
565
|
+
p result
|
566
|
+
rescue DocuSign_eSign::ApiError => e
|
567
|
+
puts "Exception when calling TemplatesApi->delete_document_fields: #{e}"
|
568
|
+
end
|
569
|
+
```
|
570
|
+
|
571
|
+
### Parameters
|
572
|
+
|
573
|
+
Name | Type | Description | Notes
|
574
|
+
------------- | ------------- | ------------- | -------------
|
575
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
576
|
+
**document_id** | **String**| The ID of the document being accessed. |
|
577
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
578
|
+
**document_fields_information** | [**DocumentFieldsInformation**](DocumentFieldsInformation.md)| | [optional]
|
579
|
+
|
580
|
+
### Return type
|
581
|
+
|
582
|
+
[**DocumentFieldsInformation**](DocumentFieldsInformation.md)
|
583
|
+
|
584
|
+
### Authorization
|
585
|
+
|
586
|
+
No authorization required
|
587
|
+
|
588
|
+
### HTTP request headers
|
589
|
+
|
590
|
+
- **Content-Type**: Not defined
|
591
|
+
- **Accept**: application/json
|
592
|
+
|
593
|
+
|
594
|
+
|
595
|
+
# **delete_document_page**
|
596
|
+
> delete_document_page(account_id, document_id, page_number, template_id, opts)
|
597
|
+
|
598
|
+
Deletes a page from a document in an template.
|
599
|
+
|
600
|
+
Deletes a page from a document in a template based on the page number.
|
601
|
+
|
602
|
+
### Example
|
603
|
+
```ruby
|
604
|
+
# load the gem
|
605
|
+
require 'docusign_esign'
|
606
|
+
|
607
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
608
|
+
|
609
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
610
|
+
|
611
|
+
document_id = "document_id_example" # String | The ID of the document being accessed.
|
612
|
+
|
613
|
+
page_number = "page_number_example" # String | The page number being accessed.
|
614
|
+
|
615
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
616
|
+
|
617
|
+
opts = {
|
618
|
+
page_request: DocuSign_eSign::PageRequest.new # PageRequest |
|
619
|
+
}
|
620
|
+
|
621
|
+
begin
|
622
|
+
#Deletes a page from a document in an template.
|
623
|
+
api_instance.delete_document_page(account_id, document_id, page_number, template_id, opts)
|
624
|
+
rescue DocuSign_eSign::ApiError => e
|
625
|
+
puts "Exception when calling TemplatesApi->delete_document_page: #{e}"
|
626
|
+
end
|
627
|
+
```
|
628
|
+
|
629
|
+
### Parameters
|
630
|
+
|
631
|
+
Name | Type | Description | Notes
|
632
|
+
------------- | ------------- | ------------- | -------------
|
633
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
634
|
+
**document_id** | **String**| The ID of the document being accessed. |
|
635
|
+
**page_number** | **String**| The page number being accessed. |
|
636
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
637
|
+
**page_request** | [**PageRequest**](PageRequest.md)| | [optional]
|
638
|
+
|
639
|
+
### Return type
|
640
|
+
|
641
|
+
nil (empty response body)
|
642
|
+
|
643
|
+
### Authorization
|
644
|
+
|
645
|
+
No authorization required
|
646
|
+
|
647
|
+
### HTTP request headers
|
648
|
+
|
649
|
+
- **Content-Type**: Not defined
|
650
|
+
- **Accept**: application/json
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
# **delete_documents**
|
655
|
+
> TemplateDocumentsResult delete_documents(account_id, template_id, opts)
|
656
|
+
|
657
|
+
Deletes documents from a template.
|
658
|
+
|
659
|
+
Deletes one or more documents from an existing template.
|
660
|
+
|
661
|
+
### Example
|
662
|
+
```ruby
|
663
|
+
# load the gem
|
664
|
+
require 'docusign_esign'
|
665
|
+
|
666
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
667
|
+
|
668
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
669
|
+
|
670
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
671
|
+
|
672
|
+
opts = {
|
673
|
+
envelope_definition: DocuSign_eSign::EnvelopeDefinition.new # EnvelopeDefinition |
|
674
|
+
}
|
675
|
+
|
676
|
+
begin
|
677
|
+
#Deletes documents from a template.
|
678
|
+
result = api_instance.delete_documents(account_id, template_id, opts)
|
679
|
+
p result
|
680
|
+
rescue DocuSign_eSign::ApiError => e
|
681
|
+
puts "Exception when calling TemplatesApi->delete_documents: #{e}"
|
682
|
+
end
|
683
|
+
```
|
684
|
+
|
685
|
+
### Parameters
|
686
|
+
|
687
|
+
Name | Type | Description | Notes
|
688
|
+
------------- | ------------- | ------------- | -------------
|
689
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
690
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
691
|
+
**envelope_definition** | [**EnvelopeDefinition**](EnvelopeDefinition.md)| | [optional]
|
692
|
+
|
693
|
+
### Return type
|
694
|
+
|
695
|
+
[**TemplateDocumentsResult**](TemplateDocumentsResult.md)
|
696
|
+
|
697
|
+
### Authorization
|
698
|
+
|
699
|
+
No authorization required
|
700
|
+
|
701
|
+
### HTTP request headers
|
702
|
+
|
703
|
+
- **Content-Type**: Not defined
|
704
|
+
- **Accept**: application/json
|
705
|
+
|
706
|
+
|
707
|
+
|
708
|
+
# **delete_group_share**
|
709
|
+
> GroupInformation delete_group_share(account_id, template_id, template_part, opts)
|
710
|
+
|
711
|
+
Removes a member group's sharing permissions for a template.
|
712
|
+
|
713
|
+
Removes a member group's sharing permissions for a specified template.
|
714
|
+
|
715
|
+
### Example
|
716
|
+
```ruby
|
717
|
+
# load the gem
|
718
|
+
require 'docusign_esign'
|
719
|
+
|
720
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
721
|
+
|
722
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
723
|
+
|
724
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
725
|
+
|
726
|
+
template_part = "template_part_example" # String | Currently, the only defined part is **groups**.
|
727
|
+
|
728
|
+
opts = {
|
729
|
+
group_information: DocuSign_eSign::GroupInformation.new # GroupInformation |
|
730
|
+
}
|
731
|
+
|
732
|
+
begin
|
733
|
+
#Removes a member group's sharing permissions for a template.
|
734
|
+
result = api_instance.delete_group_share(account_id, template_id, template_part, opts)
|
735
|
+
p result
|
736
|
+
rescue DocuSign_eSign::ApiError => e
|
737
|
+
puts "Exception when calling TemplatesApi->delete_group_share: #{e}"
|
738
|
+
end
|
739
|
+
```
|
740
|
+
|
741
|
+
### Parameters
|
742
|
+
|
743
|
+
Name | Type | Description | Notes
|
744
|
+
------------- | ------------- | ------------- | -------------
|
745
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
746
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
747
|
+
**template_part** | **String**| Currently, the only defined part is **groups**. |
|
748
|
+
**group_information** | [**GroupInformation**](GroupInformation.md)| | [optional]
|
749
|
+
|
750
|
+
### Return type
|
751
|
+
|
752
|
+
[**GroupInformation**](GroupInformation.md)
|
753
|
+
|
754
|
+
### Authorization
|
755
|
+
|
756
|
+
No authorization required
|
757
|
+
|
758
|
+
### HTTP request headers
|
759
|
+
|
760
|
+
- **Content-Type**: Not defined
|
761
|
+
- **Accept**: application/json
|
762
|
+
|
763
|
+
|
764
|
+
|
765
|
+
# **delete_lock**
|
766
|
+
> LockInformation delete_lock(account_id, template_id, opts)
|
767
|
+
|
768
|
+
Deletes a template lock.
|
769
|
+
|
770
|
+
Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
|
771
|
+
|
772
|
+
### Example
|
773
|
+
```ruby
|
774
|
+
# load the gem
|
775
|
+
require 'docusign_esign'
|
776
|
+
|
777
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
778
|
+
|
779
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
780
|
+
|
781
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
782
|
+
|
783
|
+
opts = {
|
784
|
+
lock_request: DocuSign_eSign::LockRequest.new # LockRequest |
|
785
|
+
}
|
786
|
+
|
787
|
+
begin
|
788
|
+
#Deletes a template lock.
|
789
|
+
result = api_instance.delete_lock(account_id, template_id, opts)
|
790
|
+
p result
|
791
|
+
rescue DocuSign_eSign::ApiError => e
|
792
|
+
puts "Exception when calling TemplatesApi->delete_lock: #{e}"
|
793
|
+
end
|
794
|
+
```
|
795
|
+
|
796
|
+
### Parameters
|
797
|
+
|
798
|
+
Name | Type | Description | Notes
|
799
|
+
------------- | ------------- | ------------- | -------------
|
800
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
801
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
802
|
+
**lock_request** | [**LockRequest**](LockRequest.md)| | [optional]
|
803
|
+
|
804
|
+
### Return type
|
805
|
+
|
806
|
+
[**LockInformation**](LockInformation.md)
|
807
|
+
|
808
|
+
### Authorization
|
809
|
+
|
810
|
+
No authorization required
|
811
|
+
|
812
|
+
### HTTP request headers
|
813
|
+
|
814
|
+
- **Content-Type**: Not defined
|
815
|
+
- **Accept**: application/json
|
816
|
+
|
817
|
+
|
818
|
+
|
819
|
+
# **delete_recipient**
|
820
|
+
> Recipients delete_recipient(account_id, recipient_id, template_id, opts)
|
821
|
+
|
822
|
+
Deletes the specified recipient file from a template.
|
823
|
+
|
824
|
+
Deletes the specified recipient file from the specified template.
|
825
|
+
|
826
|
+
### Example
|
827
|
+
```ruby
|
828
|
+
# load the gem
|
829
|
+
require 'docusign_esign'
|
830
|
+
|
831
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
832
|
+
|
833
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
834
|
+
|
835
|
+
recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
|
836
|
+
|
837
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
838
|
+
|
839
|
+
opts = {
|
840
|
+
template_recipients: DocuSign_eSign::TemplateRecipients.new # TemplateRecipients |
|
841
|
+
}
|
842
|
+
|
843
|
+
begin
|
844
|
+
#Deletes the specified recipient file from a template.
|
845
|
+
result = api_instance.delete_recipient(account_id, recipient_id, template_id, opts)
|
846
|
+
p result
|
847
|
+
rescue DocuSign_eSign::ApiError => e
|
848
|
+
puts "Exception when calling TemplatesApi->delete_recipient: #{e}"
|
849
|
+
end
|
850
|
+
```
|
851
|
+
|
852
|
+
### Parameters
|
853
|
+
|
854
|
+
Name | Type | Description | Notes
|
855
|
+
------------- | ------------- | ------------- | -------------
|
856
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
857
|
+
**recipient_id** | **String**| The ID of the recipient being accessed. |
|
858
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
859
|
+
**template_recipients** | [**TemplateRecipients**](TemplateRecipients.md)| | [optional]
|
860
|
+
|
861
|
+
### Return type
|
862
|
+
|
863
|
+
[**Recipients**](Recipients.md)
|
864
|
+
|
865
|
+
### Authorization
|
866
|
+
|
867
|
+
No authorization required
|
868
|
+
|
869
|
+
### HTTP request headers
|
870
|
+
|
871
|
+
- **Content-Type**: Not defined
|
872
|
+
- **Accept**: application/json
|
873
|
+
|
874
|
+
|
875
|
+
|
876
|
+
# **delete_recipients**
|
877
|
+
> Recipients delete_recipients(account_id, template_id, opts)
|
878
|
+
|
879
|
+
Deletes recipients from a template.
|
880
|
+
|
881
|
+
Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.
|
882
|
+
|
883
|
+
### Example
|
884
|
+
```ruby
|
885
|
+
# load the gem
|
886
|
+
require 'docusign_esign'
|
887
|
+
|
888
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
889
|
+
|
890
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
891
|
+
|
892
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
893
|
+
|
894
|
+
opts = {
|
895
|
+
template_recipients: DocuSign_eSign::TemplateRecipients.new # TemplateRecipients |
|
896
|
+
}
|
897
|
+
|
898
|
+
begin
|
899
|
+
#Deletes recipients from a template.
|
900
|
+
result = api_instance.delete_recipients(account_id, template_id, opts)
|
901
|
+
p result
|
902
|
+
rescue DocuSign_eSign::ApiError => e
|
903
|
+
puts "Exception when calling TemplatesApi->delete_recipients: #{e}"
|
904
|
+
end
|
905
|
+
```
|
906
|
+
|
907
|
+
### Parameters
|
908
|
+
|
909
|
+
Name | Type | Description | Notes
|
910
|
+
------------- | ------------- | ------------- | -------------
|
911
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
912
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
913
|
+
**template_recipients** | [**TemplateRecipients**](TemplateRecipients.md)| | [optional]
|
914
|
+
|
915
|
+
### Return type
|
916
|
+
|
917
|
+
[**Recipients**](Recipients.md)
|
918
|
+
|
919
|
+
### Authorization
|
920
|
+
|
921
|
+
No authorization required
|
922
|
+
|
923
|
+
### HTTP request headers
|
924
|
+
|
925
|
+
- **Content-Type**: Not defined
|
926
|
+
- **Accept**: application/json
|
927
|
+
|
928
|
+
|
929
|
+
|
930
|
+
# **delete_tabs**
|
931
|
+
> Tabs delete_tabs(account_id, recipient_id, template_id, opts)
|
932
|
+
|
933
|
+
Deletes the tabs associated with a recipient in a template.
|
934
|
+
|
935
|
+
Deletes one or more tabs associated with a recipient in a template.
|
936
|
+
|
937
|
+
### Example
|
938
|
+
```ruby
|
939
|
+
# load the gem
|
940
|
+
require 'docusign_esign'
|
941
|
+
|
942
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
943
|
+
|
944
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
945
|
+
|
946
|
+
recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
|
947
|
+
|
948
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
949
|
+
|
950
|
+
opts = {
|
951
|
+
template_tabs: DocuSign_eSign::TemplateTabs.new # TemplateTabs |
|
952
|
+
}
|
953
|
+
|
954
|
+
begin
|
955
|
+
#Deletes the tabs associated with a recipient in a template.
|
956
|
+
result = api_instance.delete_tabs(account_id, recipient_id, template_id, opts)
|
957
|
+
p result
|
958
|
+
rescue DocuSign_eSign::ApiError => e
|
959
|
+
puts "Exception when calling TemplatesApi->delete_tabs: #{e}"
|
960
|
+
end
|
961
|
+
```
|
962
|
+
|
963
|
+
### Parameters
|
964
|
+
|
965
|
+
Name | Type | Description | Notes
|
966
|
+
------------- | ------------- | ------------- | -------------
|
967
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
968
|
+
**recipient_id** | **String**| The ID of the recipient being accessed. |
|
969
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
970
|
+
**template_tabs** | [**TemplateTabs**](TemplateTabs.md)| | [optional]
|
971
|
+
|
972
|
+
### Return type
|
973
|
+
|
974
|
+
[**Tabs**](Tabs.md)
|
975
|
+
|
976
|
+
### Authorization
|
977
|
+
|
978
|
+
No authorization required
|
979
|
+
|
980
|
+
### HTTP request headers
|
981
|
+
|
982
|
+
- **Content-Type**: Not defined
|
983
|
+
- **Accept**: application/json
|
984
|
+
|
985
|
+
|
986
|
+
|
987
|
+
# **get**
|
988
|
+
> EnvelopeTemplate get(account_id, template_id, opts)
|
989
|
+
|
990
|
+
Gets a list of templates for a specified account.
|
991
|
+
|
992
|
+
Retrieves the definition of the specified template.
|
993
|
+
|
994
|
+
### Example
|
995
|
+
```ruby
|
996
|
+
# load the gem
|
997
|
+
require 'docusign_esign'
|
998
|
+
|
999
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1000
|
+
|
1001
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1002
|
+
|
1003
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1004
|
+
|
1005
|
+
opts = {
|
1006
|
+
include: "include_example" # String |
|
1007
|
+
}
|
1008
|
+
|
1009
|
+
begin
|
1010
|
+
#Gets a list of templates for a specified account.
|
1011
|
+
result = api_instance.get(account_id, template_id, opts)
|
1012
|
+
p result
|
1013
|
+
rescue DocuSign_eSign::ApiError => e
|
1014
|
+
puts "Exception when calling TemplatesApi->get: #{e}"
|
1015
|
+
end
|
1016
|
+
```
|
1017
|
+
|
1018
|
+
### Parameters
|
1019
|
+
|
1020
|
+
Name | Type | Description | Notes
|
1021
|
+
------------- | ------------- | ------------- | -------------
|
1022
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1023
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1024
|
+
**include** | **String**| | [optional]
|
1025
|
+
|
1026
|
+
### Return type
|
1027
|
+
|
1028
|
+
[**EnvelopeTemplate**](EnvelopeTemplate.md)
|
1029
|
+
|
1030
|
+
### Authorization
|
1031
|
+
|
1032
|
+
No authorization required
|
1033
|
+
|
1034
|
+
### HTTP request headers
|
1035
|
+
|
1036
|
+
- **Content-Type**: Not defined
|
1037
|
+
- **Accept**: application/json
|
1038
|
+
|
1039
|
+
|
1040
|
+
|
1041
|
+
# **get_document**
|
1042
|
+
> File get_document(account_id, document_id, template_id, opts)
|
1043
|
+
|
1044
|
+
Gets PDF documents from a template.
|
1045
|
+
|
1046
|
+
Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.
|
1047
|
+
|
1048
|
+
### Example
|
1049
|
+
```ruby
|
1050
|
+
# load the gem
|
1051
|
+
require 'docusign_esign'
|
1052
|
+
|
1053
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1054
|
+
|
1055
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1056
|
+
|
1057
|
+
document_id = "document_id_example" # String | The ID of the document being accessed.
|
1058
|
+
|
1059
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1060
|
+
|
1061
|
+
opts = {
|
1062
|
+
encrypt: "encrypt_example", # String |
|
1063
|
+
show_changes: "show_changes_example" # String |
|
1064
|
+
}
|
1065
|
+
|
1066
|
+
begin
|
1067
|
+
#Gets PDF documents from a template.
|
1068
|
+
result = api_instance.get_document(account_id, document_id, template_id, opts)
|
1069
|
+
p result
|
1070
|
+
rescue DocuSign_eSign::ApiError => e
|
1071
|
+
puts "Exception when calling TemplatesApi->get_document: #{e}"
|
1072
|
+
end
|
1073
|
+
```
|
1074
|
+
|
1075
|
+
### Parameters
|
1076
|
+
|
1077
|
+
Name | Type | Description | Notes
|
1078
|
+
------------- | ------------- | ------------- | -------------
|
1079
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1080
|
+
**document_id** | **String**| The ID of the document being accessed. |
|
1081
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1082
|
+
**encrypt** | **String**| | [optional]
|
1083
|
+
**show_changes** | **String**| | [optional]
|
1084
|
+
|
1085
|
+
### Return type
|
1086
|
+
|
1087
|
+
**File**
|
1088
|
+
|
1089
|
+
### Authorization
|
1090
|
+
|
1091
|
+
No authorization required
|
1092
|
+
|
1093
|
+
### HTTP request headers
|
1094
|
+
|
1095
|
+
- **Content-Type**: Not defined
|
1096
|
+
- **Accept**: application/pdf
|
1097
|
+
|
1098
|
+
|
1099
|
+
|
1100
|
+
# **get_document_page_image**
|
1101
|
+
> File get_document_page_image(account_id, document_id, page_number, template_id, opts)
|
1102
|
+
|
1103
|
+
Gets a page image from a template for display.
|
1104
|
+
|
1105
|
+
Retrieves a page image for display from the specified template.
|
1106
|
+
|
1107
|
+
### Example
|
1108
|
+
```ruby
|
1109
|
+
# load the gem
|
1110
|
+
require 'docusign_esign'
|
1111
|
+
|
1112
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1113
|
+
|
1114
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1115
|
+
|
1116
|
+
document_id = "document_id_example" # String | The ID of the document being accessed.
|
1117
|
+
|
1118
|
+
page_number = "page_number_example" # String | The page number being accessed.
|
1119
|
+
|
1120
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1121
|
+
|
1122
|
+
opts = {
|
1123
|
+
dpi: "dpi_example", # String |
|
1124
|
+
max_height: "max_height_example", # String |
|
1125
|
+
max_width: "max_width_example", # String |
|
1126
|
+
show_changes: "show_changes_example" # String |
|
1127
|
+
}
|
1128
|
+
|
1129
|
+
begin
|
1130
|
+
#Gets a page image from a template for display.
|
1131
|
+
result = api_instance.get_document_page_image(account_id, document_id, page_number, template_id, opts)
|
1132
|
+
p result
|
1133
|
+
rescue DocuSign_eSign::ApiError => e
|
1134
|
+
puts "Exception when calling TemplatesApi->get_document_page_image: #{e}"
|
1135
|
+
end
|
1136
|
+
```
|
1137
|
+
|
1138
|
+
### Parameters
|
1139
|
+
|
1140
|
+
Name | Type | Description | Notes
|
1141
|
+
------------- | ------------- | ------------- | -------------
|
1142
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1143
|
+
**document_id** | **String**| The ID of the document being accessed. |
|
1144
|
+
**page_number** | **String**| The page number being accessed. |
|
1145
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1146
|
+
**dpi** | **String**| | [optional]
|
1147
|
+
**max_height** | **String**| | [optional]
|
1148
|
+
**max_width** | **String**| | [optional]
|
1149
|
+
**show_changes** | **String**| | [optional]
|
1150
|
+
|
1151
|
+
### Return type
|
1152
|
+
|
1153
|
+
**File**
|
1154
|
+
|
1155
|
+
### Authorization
|
1156
|
+
|
1157
|
+
No authorization required
|
1158
|
+
|
1159
|
+
### HTTP request headers
|
1160
|
+
|
1161
|
+
- **Content-Type**: Not defined
|
1162
|
+
- **Accept**: image/png
|
1163
|
+
|
1164
|
+
|
1165
|
+
|
1166
|
+
# **get_lock**
|
1167
|
+
> LockInformation get_lock(account_id, template_id)
|
1168
|
+
|
1169
|
+
Gets template lock information.
|
1170
|
+
|
1171
|
+
Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
|
1172
|
+
|
1173
|
+
### Example
|
1174
|
+
```ruby
|
1175
|
+
# load the gem
|
1176
|
+
require 'docusign_esign'
|
1177
|
+
|
1178
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1179
|
+
|
1180
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1181
|
+
|
1182
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1183
|
+
|
1184
|
+
|
1185
|
+
begin
|
1186
|
+
#Gets template lock information.
|
1187
|
+
result = api_instance.get_lock(account_id, template_id)
|
1188
|
+
p result
|
1189
|
+
rescue DocuSign_eSign::ApiError => e
|
1190
|
+
puts "Exception when calling TemplatesApi->get_lock: #{e}"
|
1191
|
+
end
|
1192
|
+
```
|
1193
|
+
|
1194
|
+
### Parameters
|
1195
|
+
|
1196
|
+
Name | Type | Description | Notes
|
1197
|
+
------------- | ------------- | ------------- | -------------
|
1198
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1199
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1200
|
+
|
1201
|
+
### Return type
|
1202
|
+
|
1203
|
+
[**LockInformation**](LockInformation.md)
|
1204
|
+
|
1205
|
+
### Authorization
|
1206
|
+
|
1207
|
+
No authorization required
|
1208
|
+
|
1209
|
+
### HTTP request headers
|
1210
|
+
|
1211
|
+
- **Content-Type**: Not defined
|
1212
|
+
- **Accept**: application/json
|
1213
|
+
|
1214
|
+
|
1215
|
+
|
1216
|
+
# **get_notification_settings**
|
1217
|
+
> Notification get_notification_settings(account_id, template_id)
|
1218
|
+
|
1219
|
+
Gets template notification information.
|
1220
|
+
|
1221
|
+
Retrieves the envelope notification, reminders and expirations, information for an existing template.
|
1222
|
+
|
1223
|
+
### Example
|
1224
|
+
```ruby
|
1225
|
+
# load the gem
|
1226
|
+
require 'docusign_esign'
|
1227
|
+
|
1228
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1229
|
+
|
1230
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1231
|
+
|
1232
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1233
|
+
|
1234
|
+
|
1235
|
+
begin
|
1236
|
+
#Gets template notification information.
|
1237
|
+
result = api_instance.get_notification_settings(account_id, template_id)
|
1238
|
+
p result
|
1239
|
+
rescue DocuSign_eSign::ApiError => e
|
1240
|
+
puts "Exception when calling TemplatesApi->get_notification_settings: #{e}"
|
1241
|
+
end
|
1242
|
+
```
|
1243
|
+
|
1244
|
+
### Parameters
|
1245
|
+
|
1246
|
+
Name | Type | Description | Notes
|
1247
|
+
------------- | ------------- | ------------- | -------------
|
1248
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1249
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1250
|
+
|
1251
|
+
### Return type
|
1252
|
+
|
1253
|
+
[**Notification**](Notification.md)
|
1254
|
+
|
1255
|
+
### Authorization
|
1256
|
+
|
1257
|
+
No authorization required
|
1258
|
+
|
1259
|
+
### HTTP request headers
|
1260
|
+
|
1261
|
+
- **Content-Type**: Not defined
|
1262
|
+
- **Accept**: application/json
|
1263
|
+
|
1264
|
+
|
1265
|
+
|
1266
|
+
# **list_bulk_recipients**
|
1267
|
+
> BulkRecipientsResponse list_bulk_recipients(account_id, recipient_id, template_id, opts)
|
1268
|
+
|
1269
|
+
Gets the bulk recipient file from a template.
|
1270
|
+
|
1271
|
+
Retrieves the bulk recipient file information from a template that has a bulk recipient.
|
1272
|
+
|
1273
|
+
### Example
|
1274
|
+
```ruby
|
1275
|
+
# load the gem
|
1276
|
+
require 'docusign_esign'
|
1277
|
+
|
1278
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1279
|
+
|
1280
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1281
|
+
|
1282
|
+
recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
|
1283
|
+
|
1284
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1285
|
+
|
1286
|
+
opts = {
|
1287
|
+
include_tabs: "include_tabs_example", # String |
|
1288
|
+
start_position: "start_position_example" # String |
|
1289
|
+
}
|
1290
|
+
|
1291
|
+
begin
|
1292
|
+
#Gets the bulk recipient file from a template.
|
1293
|
+
result = api_instance.list_bulk_recipients(account_id, recipient_id, template_id, opts)
|
1294
|
+
p result
|
1295
|
+
rescue DocuSign_eSign::ApiError => e
|
1296
|
+
puts "Exception when calling TemplatesApi->list_bulk_recipients: #{e}"
|
1297
|
+
end
|
1298
|
+
```
|
1299
|
+
|
1300
|
+
### Parameters
|
1301
|
+
|
1302
|
+
Name | Type | Description | Notes
|
1303
|
+
------------- | ------------- | ------------- | -------------
|
1304
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1305
|
+
**recipient_id** | **String**| The ID of the recipient being accessed. |
|
1306
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1307
|
+
**include_tabs** | **String**| | [optional]
|
1308
|
+
**start_position** | **String**| | [optional]
|
1309
|
+
|
1310
|
+
### Return type
|
1311
|
+
|
1312
|
+
[**BulkRecipientsResponse**](BulkRecipientsResponse.md)
|
1313
|
+
|
1314
|
+
### Authorization
|
1315
|
+
|
1316
|
+
No authorization required
|
1317
|
+
|
1318
|
+
### HTTP request headers
|
1319
|
+
|
1320
|
+
- **Content-Type**: Not defined
|
1321
|
+
- **Accept**: application/json
|
1322
|
+
|
1323
|
+
|
1324
|
+
|
1325
|
+
# **list_custom_fields**
|
1326
|
+
> CustomFields list_custom_fields(account_id, template_id)
|
1327
|
+
|
1328
|
+
Gets the custom document fields from a template.
|
1329
|
+
|
1330
|
+
Retrieves the custom document field information from an existing template.
|
1331
|
+
|
1332
|
+
### Example
|
1333
|
+
```ruby
|
1334
|
+
# load the gem
|
1335
|
+
require 'docusign_esign'
|
1336
|
+
|
1337
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1338
|
+
|
1339
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1340
|
+
|
1341
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1342
|
+
|
1343
|
+
|
1344
|
+
begin
|
1345
|
+
#Gets the custom document fields from a template.
|
1346
|
+
result = api_instance.list_custom_fields(account_id, template_id)
|
1347
|
+
p result
|
1348
|
+
rescue DocuSign_eSign::ApiError => e
|
1349
|
+
puts "Exception when calling TemplatesApi->list_custom_fields: #{e}"
|
1350
|
+
end
|
1351
|
+
```
|
1352
|
+
|
1353
|
+
### Parameters
|
1354
|
+
|
1355
|
+
Name | Type | Description | Notes
|
1356
|
+
------------- | ------------- | ------------- | -------------
|
1357
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1358
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1359
|
+
|
1360
|
+
### Return type
|
1361
|
+
|
1362
|
+
[**CustomFields**](CustomFields.md)
|
1363
|
+
|
1364
|
+
### Authorization
|
1365
|
+
|
1366
|
+
No authorization required
|
1367
|
+
|
1368
|
+
### HTTP request headers
|
1369
|
+
|
1370
|
+
- **Content-Type**: Not defined
|
1371
|
+
- **Accept**: application/json
|
1372
|
+
|
1373
|
+
|
1374
|
+
|
1375
|
+
# **list_document_fields**
|
1376
|
+
> DocumentFieldsInformation list_document_fields(account_id, document_id, template_id)
|
1377
|
+
|
1378
|
+
Gets the custom document fields for a an existing template document.
|
1379
|
+
|
1380
|
+
Retrieves the custom document fields for an existing template document.
|
1381
|
+
|
1382
|
+
### Example
|
1383
|
+
```ruby
|
1384
|
+
# load the gem
|
1385
|
+
require 'docusign_esign'
|
1386
|
+
|
1387
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1388
|
+
|
1389
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1390
|
+
|
1391
|
+
document_id = "document_id_example" # String | The ID of the document being accessed.
|
1392
|
+
|
1393
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1394
|
+
|
1395
|
+
|
1396
|
+
begin
|
1397
|
+
#Gets the custom document fields for a an existing template document.
|
1398
|
+
result = api_instance.list_document_fields(account_id, document_id, template_id)
|
1399
|
+
p result
|
1400
|
+
rescue DocuSign_eSign::ApiError => e
|
1401
|
+
puts "Exception when calling TemplatesApi->list_document_fields: #{e}"
|
1402
|
+
end
|
1403
|
+
```
|
1404
|
+
|
1405
|
+
### Parameters
|
1406
|
+
|
1407
|
+
Name | Type | Description | Notes
|
1408
|
+
------------- | ------------- | ------------- | -------------
|
1409
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1410
|
+
**document_id** | **String**| The ID of the document being accessed. |
|
1411
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1412
|
+
|
1413
|
+
### Return type
|
1414
|
+
|
1415
|
+
[**DocumentFieldsInformation**](DocumentFieldsInformation.md)
|
1416
|
+
|
1417
|
+
### Authorization
|
1418
|
+
|
1419
|
+
No authorization required
|
1420
|
+
|
1421
|
+
### HTTP request headers
|
1422
|
+
|
1423
|
+
- **Content-Type**: Not defined
|
1424
|
+
- **Accept**: application/json
|
1425
|
+
|
1426
|
+
|
1427
|
+
|
1428
|
+
# **list_documents**
|
1429
|
+
> TemplateDocumentsResult list_documents(account_id, template_id)
|
1430
|
+
|
1431
|
+
Gets a list of documents associated with a template.
|
1432
|
+
|
1433
|
+
Retrieves a list of documents associated with the specified template.
|
1434
|
+
|
1435
|
+
### Example
|
1436
|
+
```ruby
|
1437
|
+
# load the gem
|
1438
|
+
require 'docusign_esign'
|
1439
|
+
|
1440
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1441
|
+
|
1442
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1443
|
+
|
1444
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1445
|
+
|
1446
|
+
|
1447
|
+
begin
|
1448
|
+
#Gets a list of documents associated with a template.
|
1449
|
+
result = api_instance.list_documents(account_id, template_id)
|
1450
|
+
p result
|
1451
|
+
rescue DocuSign_eSign::ApiError => e
|
1452
|
+
puts "Exception when calling TemplatesApi->list_documents: #{e}"
|
1453
|
+
end
|
1454
|
+
```
|
1455
|
+
|
1456
|
+
### Parameters
|
1457
|
+
|
1458
|
+
Name | Type | Description | Notes
|
1459
|
+
------------- | ------------- | ------------- | -------------
|
1460
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1461
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1462
|
+
|
1463
|
+
### Return type
|
1464
|
+
|
1465
|
+
[**TemplateDocumentsResult**](TemplateDocumentsResult.md)
|
1466
|
+
|
1467
|
+
### Authorization
|
1468
|
+
|
1469
|
+
No authorization required
|
1470
|
+
|
1471
|
+
### HTTP request headers
|
1472
|
+
|
1473
|
+
- **Content-Type**: Not defined
|
1474
|
+
- **Accept**: application/json
|
1475
|
+
|
1476
|
+
|
1477
|
+
|
1478
|
+
# **list_recipients**
|
1479
|
+
> Recipients list_recipients(account_id, template_id, opts)
|
1480
|
+
|
1481
|
+
Gets recipient information from a template.
|
1482
|
+
|
1483
|
+
Retrieves the information for all recipients in the specified template.
|
1484
|
+
|
1485
|
+
### Example
|
1486
|
+
```ruby
|
1487
|
+
# load the gem
|
1488
|
+
require 'docusign_esign'
|
1489
|
+
|
1490
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1491
|
+
|
1492
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1493
|
+
|
1494
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1495
|
+
|
1496
|
+
opts = {
|
1497
|
+
include_anchor_tab_locations: "include_anchor_tab_locations_example", # String | When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response.
|
1498
|
+
include_extended: "include_extended_example", # String | When set to **true**, the extended properties are included in the response.
|
1499
|
+
include_tabs: "include_tabs_example" # String | When set to **true**, the tab information associated with the recipient is included in the response.
|
1500
|
+
}
|
1501
|
+
|
1502
|
+
begin
|
1503
|
+
#Gets recipient information from a template.
|
1504
|
+
result = api_instance.list_recipients(account_id, template_id, opts)
|
1505
|
+
p result
|
1506
|
+
rescue DocuSign_eSign::ApiError => e
|
1507
|
+
puts "Exception when calling TemplatesApi->list_recipients: #{e}"
|
1508
|
+
end
|
1509
|
+
```
|
1510
|
+
|
1511
|
+
### Parameters
|
1512
|
+
|
1513
|
+
Name | Type | Description | Notes
|
1514
|
+
------------- | ------------- | ------------- | -------------
|
1515
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1516
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1517
|
+
**include_anchor_tab_locations** | **String**| When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response. | [optional]
|
1518
|
+
**include_extended** | **String**| When set to **true**, the extended properties are included in the response. | [optional]
|
1519
|
+
**include_tabs** | **String**| When set to **true**, the tab information associated with the recipient is included in the response. | [optional]
|
1520
|
+
|
1521
|
+
### Return type
|
1522
|
+
|
1523
|
+
[**Recipients**](Recipients.md)
|
1524
|
+
|
1525
|
+
### Authorization
|
1526
|
+
|
1527
|
+
No authorization required
|
1528
|
+
|
1529
|
+
### HTTP request headers
|
1530
|
+
|
1531
|
+
- **Content-Type**: Not defined
|
1532
|
+
- **Accept**: application/json
|
1533
|
+
|
1534
|
+
|
1535
|
+
|
1536
|
+
# **list_tabs**
|
1537
|
+
> Tabs list_tabs(account_id, recipient_id, template_id, opts)
|
1538
|
+
|
1539
|
+
Gets the tabs information for a signer or sign-in-person recipient in a template.
|
1540
|
+
|
1541
|
+
Gets the tabs information for a signer or sign-in-person recipient in a template.
|
1542
|
+
|
1543
|
+
### Example
|
1544
|
+
```ruby
|
1545
|
+
# load the gem
|
1546
|
+
require 'docusign_esign'
|
1547
|
+
|
1548
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1549
|
+
|
1550
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1551
|
+
|
1552
|
+
recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
|
1553
|
+
|
1554
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1555
|
+
|
1556
|
+
opts = {
|
1557
|
+
include_anchor_tab_locations: "include_anchor_tab_locations_example", # String | When set to **true**, all tabs with anchor tab properties are included in the response.
|
1558
|
+
include_metadata: "include_metadata_example" # String |
|
1559
|
+
}
|
1560
|
+
|
1561
|
+
begin
|
1562
|
+
#Gets the tabs information for a signer or sign-in-person recipient in a template.
|
1563
|
+
result = api_instance.list_tabs(account_id, recipient_id, template_id, opts)
|
1564
|
+
p result
|
1565
|
+
rescue DocuSign_eSign::ApiError => e
|
1566
|
+
puts "Exception when calling TemplatesApi->list_tabs: #{e}"
|
1567
|
+
end
|
1568
|
+
```
|
1569
|
+
|
1570
|
+
### Parameters
|
1571
|
+
|
1572
|
+
Name | Type | Description | Notes
|
1573
|
+
------------- | ------------- | ------------- | -------------
|
1574
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1575
|
+
**recipient_id** | **String**| The ID of the recipient being accessed. |
|
1576
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1577
|
+
**include_anchor_tab_locations** | **String**| When set to **true**, all tabs with anchor tab properties are included in the response. | [optional]
|
1578
|
+
**include_metadata** | **String**| | [optional]
|
1579
|
+
|
1580
|
+
### Return type
|
1581
|
+
|
1582
|
+
[**Tabs**](Tabs.md)
|
1583
|
+
|
1584
|
+
### Authorization
|
1585
|
+
|
1586
|
+
No authorization required
|
1587
|
+
|
1588
|
+
### HTTP request headers
|
1589
|
+
|
1590
|
+
- **Content-Type**: Not defined
|
1591
|
+
- **Accept**: application/json
|
1592
|
+
|
1593
|
+
|
1594
|
+
|
1595
|
+
# **list_templates**
|
1596
|
+
> EnvelopeTemplateResults list_templates(account_id, opts)
|
1597
|
+
|
1598
|
+
Gets the definition of a template.
|
1599
|
+
|
1600
|
+
Retrieves the list of templates for the specified account. The request can be limited to a specific folder.
|
1601
|
+
|
1602
|
+
### Example
|
1603
|
+
```ruby
|
1604
|
+
# load the gem
|
1605
|
+
require 'docusign_esign'
|
1606
|
+
|
1607
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1608
|
+
|
1609
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1610
|
+
|
1611
|
+
opts = {
|
1612
|
+
count: "count_example", # String | Number of records to return in the cache.
|
1613
|
+
folder: "folder_example", # String | The query value can be a folder name or folder ID. The response will only return templates in the specified folder.
|
1614
|
+
folder_ids: "folder_ids_example", # String | A comma separated list of folder ID GUIDs.
|
1615
|
+
from_date: "from_date_example", # String | Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
|
1616
|
+
include: "include_example", # String | A comma separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
|
1617
|
+
order: "order_example", # String | Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a)
|
1618
|
+
order_by: "order_by_example", # String | Sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used.
|
1619
|
+
search_text: "search_text_example", # String | The search text used to search the names of templates.
|
1620
|
+
shared: "shared_example", # String |
|
1621
|
+
shared_by_me: "shared_by_me_example", # String | If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.
|
1622
|
+
start_position: "start_position_example", # String | The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).
|
1623
|
+
to_date: "to_date_example", # String | End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.
|
1624
|
+
used_from_date: "used_from_date_example", # String | Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.
|
1625
|
+
used_to_date: "used_to_date_example", # String | End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.
|
1626
|
+
user_filter: "user_filter_example" # String | Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user.
|
1627
|
+
}
|
1628
|
+
|
1629
|
+
begin
|
1630
|
+
#Gets the definition of a template.
|
1631
|
+
result = api_instance.list_templates(account_id, opts)
|
1632
|
+
p result
|
1633
|
+
rescue DocuSign_eSign::ApiError => e
|
1634
|
+
puts "Exception when calling TemplatesApi->list_templates: #{e}"
|
1635
|
+
end
|
1636
|
+
```
|
1637
|
+
|
1638
|
+
### Parameters
|
1639
|
+
|
1640
|
+
Name | Type | Description | Notes
|
1641
|
+
------------- | ------------- | ------------- | -------------
|
1642
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1643
|
+
**count** | **String**| Number of records to return in the cache. | [optional]
|
1644
|
+
**folder** | **String**| The query value can be a folder name or folder ID. The response will only return templates in the specified folder. | [optional]
|
1645
|
+
**folder_ids** | **String**| A comma separated list of folder ID GUIDs. | [optional]
|
1646
|
+
**from_date** | **String**| Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created. | [optional]
|
1647
|
+
**include** | **String**| A comma separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications. | [optional]
|
1648
|
+
**order** | **String**| Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a) | [optional]
|
1649
|
+
**order_by** | **String**| Sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used. | [optional]
|
1650
|
+
**search_text** | **String**| The search text used to search the names of templates. | [optional]
|
1651
|
+
**shared** | **String**| | [optional]
|
1652
|
+
**shared_by_me** | **String**| If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected. | [optional]
|
1653
|
+
**start_position** | **String**| The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero). | [optional]
|
1654
|
+
**to_date** | **String**| End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date. | [optional]
|
1655
|
+
**used_from_date** | **String**| Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used. | [optional]
|
1656
|
+
**used_to_date** | **String**| End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date. | [optional]
|
1657
|
+
**user_filter** | **String**| Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user. | [optional]
|
1658
|
+
|
1659
|
+
### Return type
|
1660
|
+
|
1661
|
+
[**EnvelopeTemplateResults**](EnvelopeTemplateResults.md)
|
1662
|
+
|
1663
|
+
### Authorization
|
1664
|
+
|
1665
|
+
No authorization required
|
1666
|
+
|
1667
|
+
### HTTP request headers
|
1668
|
+
|
1669
|
+
- **Content-Type**: Not defined
|
1670
|
+
- **Accept**: application/json
|
1671
|
+
|
1672
|
+
|
1673
|
+
|
1674
|
+
# **rotate_document_page**
|
1675
|
+
> rotate_document_page(account_id, document_id, page_number, template_id, opts)
|
1676
|
+
|
1677
|
+
Rotates page image from a template for display.
|
1678
|
+
|
1679
|
+
Rotates page image from a template for display. The page image can be rotated to the left or right.
|
1680
|
+
|
1681
|
+
### Example
|
1682
|
+
```ruby
|
1683
|
+
# load the gem
|
1684
|
+
require 'docusign_esign'
|
1685
|
+
|
1686
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1687
|
+
|
1688
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1689
|
+
|
1690
|
+
document_id = "document_id_example" # String | The ID of the document being accessed.
|
1691
|
+
|
1692
|
+
page_number = "page_number_example" # String | The page number being accessed.
|
1693
|
+
|
1694
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1695
|
+
|
1696
|
+
opts = {
|
1697
|
+
page_request: DocuSign_eSign::PageRequest.new # PageRequest |
|
1698
|
+
}
|
1699
|
+
|
1700
|
+
begin
|
1701
|
+
#Rotates page image from a template for display.
|
1702
|
+
api_instance.rotate_document_page(account_id, document_id, page_number, template_id, opts)
|
1703
|
+
rescue DocuSign_eSign::ApiError => e
|
1704
|
+
puts "Exception when calling TemplatesApi->rotate_document_page: #{e}"
|
1705
|
+
end
|
1706
|
+
```
|
1707
|
+
|
1708
|
+
### Parameters
|
1709
|
+
|
1710
|
+
Name | Type | Description | Notes
|
1711
|
+
------------- | ------------- | ------------- | -------------
|
1712
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1713
|
+
**document_id** | **String**| The ID of the document being accessed. |
|
1714
|
+
**page_number** | **String**| The page number being accessed. |
|
1715
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1716
|
+
**page_request** | [**PageRequest**](PageRequest.md)| | [optional]
|
1717
|
+
|
1718
|
+
### Return type
|
1719
|
+
|
1720
|
+
nil (empty response body)
|
1721
|
+
|
1722
|
+
### Authorization
|
1723
|
+
|
1724
|
+
No authorization required
|
1725
|
+
|
1726
|
+
### HTTP request headers
|
1727
|
+
|
1728
|
+
- **Content-Type**: Not defined
|
1729
|
+
- **Accept**: application/json
|
1730
|
+
|
1731
|
+
|
1732
|
+
|
1733
|
+
# **update**
|
1734
|
+
> TemplateUpdateSummary update(account_id, template_id, opts)
|
1735
|
+
|
1736
|
+
Updates an existing template.
|
1737
|
+
|
1738
|
+
Updates an existing template.
|
1739
|
+
|
1740
|
+
### Example
|
1741
|
+
```ruby
|
1742
|
+
# load the gem
|
1743
|
+
require 'docusign_esign'
|
1744
|
+
|
1745
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1746
|
+
|
1747
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1748
|
+
|
1749
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1750
|
+
|
1751
|
+
opts = {
|
1752
|
+
envelope_template: DocuSign_eSign::EnvelopeTemplate.new # EnvelopeTemplate |
|
1753
|
+
}
|
1754
|
+
|
1755
|
+
begin
|
1756
|
+
#Updates an existing template.
|
1757
|
+
result = api_instance.update(account_id, template_id, opts)
|
1758
|
+
p result
|
1759
|
+
rescue DocuSign_eSign::ApiError => e
|
1760
|
+
puts "Exception when calling TemplatesApi->update: #{e}"
|
1761
|
+
end
|
1762
|
+
```
|
1763
|
+
|
1764
|
+
### Parameters
|
1765
|
+
|
1766
|
+
Name | Type | Description | Notes
|
1767
|
+
------------- | ------------- | ------------- | -------------
|
1768
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1769
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1770
|
+
**envelope_template** | [**EnvelopeTemplate**](EnvelopeTemplate.md)| | [optional]
|
1771
|
+
|
1772
|
+
### Return type
|
1773
|
+
|
1774
|
+
[**TemplateUpdateSummary**](TemplateUpdateSummary.md)
|
1775
|
+
|
1776
|
+
### Authorization
|
1777
|
+
|
1778
|
+
No authorization required
|
1779
|
+
|
1780
|
+
### HTTP request headers
|
1781
|
+
|
1782
|
+
- **Content-Type**: Not defined
|
1783
|
+
- **Accept**: application/json
|
1784
|
+
|
1785
|
+
|
1786
|
+
|
1787
|
+
# **update_bulk_recipients**
|
1788
|
+
> BulkRecipientsSummaryResponse update_bulk_recipients(account_id, recipient_id, template_id, opts)
|
1789
|
+
|
1790
|
+
Adds or replaces the bulk recipients list in a template.
|
1791
|
+
|
1792
|
+
Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
|
1793
|
+
|
1794
|
+
### Example
|
1795
|
+
```ruby
|
1796
|
+
# load the gem
|
1797
|
+
require 'docusign_esign'
|
1798
|
+
|
1799
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1800
|
+
|
1801
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1802
|
+
|
1803
|
+
recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
|
1804
|
+
|
1805
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1806
|
+
|
1807
|
+
opts = {
|
1808
|
+
bulk_recipients_request: DocuSign_eSign::BulkRecipientsRequest.new # BulkRecipientsRequest |
|
1809
|
+
}
|
1810
|
+
|
1811
|
+
begin
|
1812
|
+
#Adds or replaces the bulk recipients list in a template.
|
1813
|
+
result = api_instance.update_bulk_recipients(account_id, recipient_id, template_id, opts)
|
1814
|
+
p result
|
1815
|
+
rescue DocuSign_eSign::ApiError => e
|
1816
|
+
puts "Exception when calling TemplatesApi->update_bulk_recipients: #{e}"
|
1817
|
+
end
|
1818
|
+
```
|
1819
|
+
|
1820
|
+
### Parameters
|
1821
|
+
|
1822
|
+
Name | Type | Description | Notes
|
1823
|
+
------------- | ------------- | ------------- | -------------
|
1824
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1825
|
+
**recipient_id** | **String**| The ID of the recipient being accessed. |
|
1826
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1827
|
+
**bulk_recipients_request** | [**BulkRecipientsRequest**](BulkRecipientsRequest.md)| | [optional]
|
1828
|
+
|
1829
|
+
### Return type
|
1830
|
+
|
1831
|
+
[**BulkRecipientsSummaryResponse**](BulkRecipientsSummaryResponse.md)
|
1832
|
+
|
1833
|
+
### Authorization
|
1834
|
+
|
1835
|
+
No authorization required
|
1836
|
+
|
1837
|
+
### HTTP request headers
|
1838
|
+
|
1839
|
+
- **Content-Type**: Not defined
|
1840
|
+
- **Accept**: application/json
|
1841
|
+
|
1842
|
+
|
1843
|
+
|
1844
|
+
# **update_custom_fields**
|
1845
|
+
> CustomFields update_custom_fields(account_id, template_id, opts)
|
1846
|
+
|
1847
|
+
Updates envelope custom fields in a template.
|
1848
|
+
|
1849
|
+
Updates the custom fields in a template. Each custom field used in a template must have a unique name.
|
1850
|
+
|
1851
|
+
### Example
|
1852
|
+
```ruby
|
1853
|
+
# load the gem
|
1854
|
+
require 'docusign_esign'
|
1855
|
+
|
1856
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1857
|
+
|
1858
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1859
|
+
|
1860
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1861
|
+
|
1862
|
+
opts = {
|
1863
|
+
template_custom_fields: DocuSign_eSign::TemplateCustomFields.new # TemplateCustomFields |
|
1864
|
+
}
|
1865
|
+
|
1866
|
+
begin
|
1867
|
+
#Updates envelope custom fields in a template.
|
1868
|
+
result = api_instance.update_custom_fields(account_id, template_id, opts)
|
1869
|
+
p result
|
1870
|
+
rescue DocuSign_eSign::ApiError => e
|
1871
|
+
puts "Exception when calling TemplatesApi->update_custom_fields: #{e}"
|
1872
|
+
end
|
1873
|
+
```
|
1874
|
+
|
1875
|
+
### Parameters
|
1876
|
+
|
1877
|
+
Name | Type | Description | Notes
|
1878
|
+
------------- | ------------- | ------------- | -------------
|
1879
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1880
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1881
|
+
**template_custom_fields** | [**TemplateCustomFields**](TemplateCustomFields.md)| | [optional]
|
1882
|
+
|
1883
|
+
### Return type
|
1884
|
+
|
1885
|
+
[**CustomFields**](CustomFields.md)
|
1886
|
+
|
1887
|
+
### Authorization
|
1888
|
+
|
1889
|
+
No authorization required
|
1890
|
+
|
1891
|
+
### HTTP request headers
|
1892
|
+
|
1893
|
+
- **Content-Type**: Not defined
|
1894
|
+
- **Accept**: application/json
|
1895
|
+
|
1896
|
+
|
1897
|
+
|
1898
|
+
# **update_document**
|
1899
|
+
> EnvelopeDocument update_document(account_id, document_id, template_id, opts)
|
1900
|
+
|
1901
|
+
Adds a document to a template document.
|
1902
|
+
|
1903
|
+
Adds the specified document to an existing template document.
|
1904
|
+
|
1905
|
+
### Example
|
1906
|
+
```ruby
|
1907
|
+
# load the gem
|
1908
|
+
require 'docusign_esign'
|
1909
|
+
|
1910
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1911
|
+
|
1912
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1913
|
+
|
1914
|
+
document_id = "document_id_example" # String | The ID of the document being accessed.
|
1915
|
+
|
1916
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1917
|
+
|
1918
|
+
opts = {
|
1919
|
+
apply_document_fields: "apply_document_fields_example", # String |
|
1920
|
+
is_envelope_definition: "is_envelope_definition_example", # String |
|
1921
|
+
envelope_definition: DocuSign_eSign::EnvelopeDefinition.new # EnvelopeDefinition |
|
1922
|
+
}
|
1923
|
+
|
1924
|
+
begin
|
1925
|
+
#Adds a document to a template document.
|
1926
|
+
result = api_instance.update_document(account_id, document_id, template_id, opts)
|
1927
|
+
p result
|
1928
|
+
rescue DocuSign_eSign::ApiError => e
|
1929
|
+
puts "Exception when calling TemplatesApi->update_document: #{e}"
|
1930
|
+
end
|
1931
|
+
```
|
1932
|
+
|
1933
|
+
### Parameters
|
1934
|
+
|
1935
|
+
Name | Type | Description | Notes
|
1936
|
+
------------- | ------------- | ------------- | -------------
|
1937
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1938
|
+
**document_id** | **String**| The ID of the document being accessed. |
|
1939
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1940
|
+
**apply_document_fields** | **String**| | [optional]
|
1941
|
+
**is_envelope_definition** | **String**| | [optional]
|
1942
|
+
**envelope_definition** | [**EnvelopeDefinition**](EnvelopeDefinition.md)| | [optional]
|
1943
|
+
|
1944
|
+
### Return type
|
1945
|
+
|
1946
|
+
[**EnvelopeDocument**](EnvelopeDocument.md)
|
1947
|
+
|
1948
|
+
### Authorization
|
1949
|
+
|
1950
|
+
No authorization required
|
1951
|
+
|
1952
|
+
### HTTP request headers
|
1953
|
+
|
1954
|
+
- **Content-Type**: Not defined
|
1955
|
+
- **Accept**: application/json
|
1956
|
+
|
1957
|
+
|
1958
|
+
|
1959
|
+
# **update_document_fields**
|
1960
|
+
> DocumentFieldsInformation update_document_fields(account_id, document_id, template_id, opts)
|
1961
|
+
|
1962
|
+
Updates existing custom document fields in an existing template document.
|
1963
|
+
|
1964
|
+
Updates existing custom document fields in an existing template document.
|
1965
|
+
|
1966
|
+
### Example
|
1967
|
+
```ruby
|
1968
|
+
# load the gem
|
1969
|
+
require 'docusign_esign'
|
1970
|
+
|
1971
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
1972
|
+
|
1973
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
1974
|
+
|
1975
|
+
document_id = "document_id_example" # String | The ID of the document being accessed.
|
1976
|
+
|
1977
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
1978
|
+
|
1979
|
+
opts = {
|
1980
|
+
document_fields_information: DocuSign_eSign::DocumentFieldsInformation.new # DocumentFieldsInformation |
|
1981
|
+
}
|
1982
|
+
|
1983
|
+
begin
|
1984
|
+
#Updates existing custom document fields in an existing template document.
|
1985
|
+
result = api_instance.update_document_fields(account_id, document_id, template_id, opts)
|
1986
|
+
p result
|
1987
|
+
rescue DocuSign_eSign::ApiError => e
|
1988
|
+
puts "Exception when calling TemplatesApi->update_document_fields: #{e}"
|
1989
|
+
end
|
1990
|
+
```
|
1991
|
+
|
1992
|
+
### Parameters
|
1993
|
+
|
1994
|
+
Name | Type | Description | Notes
|
1995
|
+
------------- | ------------- | ------------- | -------------
|
1996
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
1997
|
+
**document_id** | **String**| The ID of the document being accessed. |
|
1998
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
1999
|
+
**document_fields_information** | [**DocumentFieldsInformation**](DocumentFieldsInformation.md)| | [optional]
|
2000
|
+
|
2001
|
+
### Return type
|
2002
|
+
|
2003
|
+
[**DocumentFieldsInformation**](DocumentFieldsInformation.md)
|
2004
|
+
|
2005
|
+
### Authorization
|
2006
|
+
|
2007
|
+
No authorization required
|
2008
|
+
|
2009
|
+
### HTTP request headers
|
2010
|
+
|
2011
|
+
- **Content-Type**: Not defined
|
2012
|
+
- **Accept**: application/json
|
2013
|
+
|
2014
|
+
|
2015
|
+
|
2016
|
+
# **update_documents**
|
2017
|
+
> TemplateDocumentsResult update_documents(account_id, template_id, opts)
|
2018
|
+
|
2019
|
+
Adds documents to a template document.
|
2020
|
+
|
2021
|
+
Adds one or more documents to an existing template document.
|
2022
|
+
|
2023
|
+
### Example
|
2024
|
+
```ruby
|
2025
|
+
# load the gem
|
2026
|
+
require 'docusign_esign'
|
2027
|
+
|
2028
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
2029
|
+
|
2030
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
2031
|
+
|
2032
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
2033
|
+
|
2034
|
+
opts = {
|
2035
|
+
apply_document_fields: "apply_document_fields_example", # String |
|
2036
|
+
envelope_definition: DocuSign_eSign::EnvelopeDefinition.new # EnvelopeDefinition |
|
2037
|
+
}
|
2038
|
+
|
2039
|
+
begin
|
2040
|
+
#Adds documents to a template document.
|
2041
|
+
result = api_instance.update_documents(account_id, template_id, opts)
|
2042
|
+
p result
|
2043
|
+
rescue DocuSign_eSign::ApiError => e
|
2044
|
+
puts "Exception when calling TemplatesApi->update_documents: #{e}"
|
2045
|
+
end
|
2046
|
+
```
|
2047
|
+
|
2048
|
+
### Parameters
|
2049
|
+
|
2050
|
+
Name | Type | Description | Notes
|
2051
|
+
------------- | ------------- | ------------- | -------------
|
2052
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
2053
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
2054
|
+
**apply_document_fields** | **String**| | [optional]
|
2055
|
+
**envelope_definition** | [**EnvelopeDefinition**](EnvelopeDefinition.md)| | [optional]
|
2056
|
+
|
2057
|
+
### Return type
|
2058
|
+
|
2059
|
+
[**TemplateDocumentsResult**](TemplateDocumentsResult.md)
|
2060
|
+
|
2061
|
+
### Authorization
|
2062
|
+
|
2063
|
+
No authorization required
|
2064
|
+
|
2065
|
+
### HTTP request headers
|
2066
|
+
|
2067
|
+
- **Content-Type**: Not defined
|
2068
|
+
- **Accept**: application/json
|
2069
|
+
|
2070
|
+
|
2071
|
+
|
2072
|
+
# **update_group_share**
|
2073
|
+
> GroupInformation update_group_share(account_id, template_id, template_part, opts)
|
2074
|
+
|
2075
|
+
Shares a template with a group
|
2076
|
+
|
2077
|
+
Shares a template with the specified members group.
|
2078
|
+
|
2079
|
+
### Example
|
2080
|
+
```ruby
|
2081
|
+
# load the gem
|
2082
|
+
require 'docusign_esign'
|
2083
|
+
|
2084
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
2085
|
+
|
2086
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
2087
|
+
|
2088
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
2089
|
+
|
2090
|
+
template_part = "template_part_example" # String | Currently, the only defined part is **groups**.
|
2091
|
+
|
2092
|
+
opts = {
|
2093
|
+
group_information: DocuSign_eSign::GroupInformation.new # GroupInformation |
|
2094
|
+
}
|
2095
|
+
|
2096
|
+
begin
|
2097
|
+
#Shares a template with a group
|
2098
|
+
result = api_instance.update_group_share(account_id, template_id, template_part, opts)
|
2099
|
+
p result
|
2100
|
+
rescue DocuSign_eSign::ApiError => e
|
2101
|
+
puts "Exception when calling TemplatesApi->update_group_share: #{e}"
|
2102
|
+
end
|
2103
|
+
```
|
2104
|
+
|
2105
|
+
### Parameters
|
2106
|
+
|
2107
|
+
Name | Type | Description | Notes
|
2108
|
+
------------- | ------------- | ------------- | -------------
|
2109
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
2110
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
2111
|
+
**template_part** | **String**| Currently, the only defined part is **groups**. |
|
2112
|
+
**group_information** | [**GroupInformation**](GroupInformation.md)| | [optional]
|
2113
|
+
|
2114
|
+
### Return type
|
2115
|
+
|
2116
|
+
[**GroupInformation**](GroupInformation.md)
|
2117
|
+
|
2118
|
+
### Authorization
|
2119
|
+
|
2120
|
+
No authorization required
|
2121
|
+
|
2122
|
+
### HTTP request headers
|
2123
|
+
|
2124
|
+
- **Content-Type**: Not defined
|
2125
|
+
- **Accept**: application/json
|
2126
|
+
|
2127
|
+
|
2128
|
+
|
2129
|
+
# **update_lock**
|
2130
|
+
> LockInformation update_lock(account_id, template_id, opts)
|
2131
|
+
|
2132
|
+
Updates a template lock.
|
2133
|
+
|
2134
|
+
Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
|
2135
|
+
|
2136
|
+
### Example
|
2137
|
+
```ruby
|
2138
|
+
# load the gem
|
2139
|
+
require 'docusign_esign'
|
2140
|
+
|
2141
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
2142
|
+
|
2143
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
2144
|
+
|
2145
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
2146
|
+
|
2147
|
+
opts = {
|
2148
|
+
lock_request: DocuSign_eSign::LockRequest.new # LockRequest |
|
2149
|
+
}
|
2150
|
+
|
2151
|
+
begin
|
2152
|
+
#Updates a template lock.
|
2153
|
+
result = api_instance.update_lock(account_id, template_id, opts)
|
2154
|
+
p result
|
2155
|
+
rescue DocuSign_eSign::ApiError => e
|
2156
|
+
puts "Exception when calling TemplatesApi->update_lock: #{e}"
|
2157
|
+
end
|
2158
|
+
```
|
2159
|
+
|
2160
|
+
### Parameters
|
2161
|
+
|
2162
|
+
Name | Type | Description | Notes
|
2163
|
+
------------- | ------------- | ------------- | -------------
|
2164
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
2165
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
2166
|
+
**lock_request** | [**LockRequest**](LockRequest.md)| | [optional]
|
2167
|
+
|
2168
|
+
### Return type
|
2169
|
+
|
2170
|
+
[**LockInformation**](LockInformation.md)
|
2171
|
+
|
2172
|
+
### Authorization
|
2173
|
+
|
2174
|
+
No authorization required
|
2175
|
+
|
2176
|
+
### HTTP request headers
|
2177
|
+
|
2178
|
+
- **Content-Type**: Not defined
|
2179
|
+
- **Accept**: application/json
|
2180
|
+
|
2181
|
+
|
2182
|
+
|
2183
|
+
# **update_notification_settings**
|
2184
|
+
> Notification update_notification_settings(account_id, template_id, opts)
|
2185
|
+
|
2186
|
+
Updates the notification structure for an existing template.
|
2187
|
+
|
2188
|
+
Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.
|
2189
|
+
|
2190
|
+
### Example
|
2191
|
+
```ruby
|
2192
|
+
# load the gem
|
2193
|
+
require 'docusign_esign'
|
2194
|
+
|
2195
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
2196
|
+
|
2197
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
2198
|
+
|
2199
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
2200
|
+
|
2201
|
+
opts = {
|
2202
|
+
template_notification_request: DocuSign_eSign::TemplateNotificationRequest.new # TemplateNotificationRequest |
|
2203
|
+
}
|
2204
|
+
|
2205
|
+
begin
|
2206
|
+
#Updates the notification structure for an existing template.
|
2207
|
+
result = api_instance.update_notification_settings(account_id, template_id, opts)
|
2208
|
+
p result
|
2209
|
+
rescue DocuSign_eSign::ApiError => e
|
2210
|
+
puts "Exception when calling TemplatesApi->update_notification_settings: #{e}"
|
2211
|
+
end
|
2212
|
+
```
|
2213
|
+
|
2214
|
+
### Parameters
|
2215
|
+
|
2216
|
+
Name | Type | Description | Notes
|
2217
|
+
------------- | ------------- | ------------- | -------------
|
2218
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
2219
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
2220
|
+
**template_notification_request** | [**TemplateNotificationRequest**](TemplateNotificationRequest.md)| | [optional]
|
2221
|
+
|
2222
|
+
### Return type
|
2223
|
+
|
2224
|
+
[**Notification**](Notification.md)
|
2225
|
+
|
2226
|
+
### Authorization
|
2227
|
+
|
2228
|
+
No authorization required
|
2229
|
+
|
2230
|
+
### HTTP request headers
|
2231
|
+
|
2232
|
+
- **Content-Type**: Not defined
|
2233
|
+
- **Accept**: application/json
|
2234
|
+
|
2235
|
+
|
2236
|
+
|
2237
|
+
# **update_recipients**
|
2238
|
+
> RecipientsUpdateSummary update_recipients(account_id, template_id, opts)
|
2239
|
+
|
2240
|
+
Updates recipients in a template.
|
2241
|
+
|
2242
|
+
Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
|
2243
|
+
|
2244
|
+
### Example
|
2245
|
+
```ruby
|
2246
|
+
# load the gem
|
2247
|
+
require 'docusign_esign'
|
2248
|
+
|
2249
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
2250
|
+
|
2251
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
2252
|
+
|
2253
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
2254
|
+
|
2255
|
+
opts = {
|
2256
|
+
resend_envelope: "resend_envelope_example", # String |
|
2257
|
+
template_recipients: DocuSign_eSign::TemplateRecipients.new # TemplateRecipients |
|
2258
|
+
}
|
2259
|
+
|
2260
|
+
begin
|
2261
|
+
#Updates recipients in a template.
|
2262
|
+
result = api_instance.update_recipients(account_id, template_id, opts)
|
2263
|
+
p result
|
2264
|
+
rescue DocuSign_eSign::ApiError => e
|
2265
|
+
puts "Exception when calling TemplatesApi->update_recipients: #{e}"
|
2266
|
+
end
|
2267
|
+
```
|
2268
|
+
|
2269
|
+
### Parameters
|
2270
|
+
|
2271
|
+
Name | Type | Description | Notes
|
2272
|
+
------------- | ------------- | ------------- | -------------
|
2273
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
2274
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
2275
|
+
**resend_envelope** | **String**| | [optional]
|
2276
|
+
**template_recipients** | [**TemplateRecipients**](TemplateRecipients.md)| | [optional]
|
2277
|
+
|
2278
|
+
### Return type
|
2279
|
+
|
2280
|
+
[**RecipientsUpdateSummary**](RecipientsUpdateSummary.md)
|
2281
|
+
|
2282
|
+
### Authorization
|
2283
|
+
|
2284
|
+
No authorization required
|
2285
|
+
|
2286
|
+
### HTTP request headers
|
2287
|
+
|
2288
|
+
- **Content-Type**: Not defined
|
2289
|
+
- **Accept**: application/json
|
2290
|
+
|
2291
|
+
|
2292
|
+
|
2293
|
+
# **update_tabs**
|
2294
|
+
> Tabs update_tabs(account_id, recipient_id, template_id, opts)
|
2295
|
+
|
2296
|
+
Updates the tabs for a recipient.
|
2297
|
+
|
2298
|
+
Updates one or more tabs for a recipient in a template.
|
2299
|
+
|
2300
|
+
### Example
|
2301
|
+
```ruby
|
2302
|
+
# load the gem
|
2303
|
+
require 'docusign_esign'
|
2304
|
+
|
2305
|
+
api_instance = DocuSign_eSign::TemplatesApi.new
|
2306
|
+
|
2307
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
2308
|
+
|
2309
|
+
recipient_id = "recipient_id_example" # String | The ID of the recipient being accessed.
|
2310
|
+
|
2311
|
+
template_id = "template_id_example" # String | The ID of the template being accessed.
|
2312
|
+
|
2313
|
+
opts = {
|
2314
|
+
template_tabs: DocuSign_eSign::TemplateTabs.new # TemplateTabs |
|
2315
|
+
}
|
2316
|
+
|
2317
|
+
begin
|
2318
|
+
#Updates the tabs for a recipient.
|
2319
|
+
result = api_instance.update_tabs(account_id, recipient_id, template_id, opts)
|
2320
|
+
p result
|
2321
|
+
rescue DocuSign_eSign::ApiError => e
|
2322
|
+
puts "Exception when calling TemplatesApi->update_tabs: #{e}"
|
2323
|
+
end
|
2324
|
+
```
|
2325
|
+
|
2326
|
+
### Parameters
|
2327
|
+
|
2328
|
+
Name | Type | Description | Notes
|
2329
|
+
------------- | ------------- | ------------- | -------------
|
2330
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
2331
|
+
**recipient_id** | **String**| The ID of the recipient being accessed. |
|
2332
|
+
**template_id** | **String**| The ID of the template being accessed. |
|
2333
|
+
**template_tabs** | [**TemplateTabs**](TemplateTabs.md)| | [optional]
|
2334
|
+
|
2335
|
+
### Return type
|
2336
|
+
|
2337
|
+
[**Tabs**](Tabs.md)
|
2338
|
+
|
2339
|
+
### Authorization
|
2340
|
+
|
2341
|
+
No authorization required
|
2342
|
+
|
2343
|
+
### HTTP request headers
|
2344
|
+
|
2345
|
+
- **Content-Type**: Not defined
|
2346
|
+
- **Accept**: application/json
|
2347
|
+
|
2348
|
+
|
2349
|
+
|