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,9 @@
|
|
|
1
|
+
# DocuSign_eSign::FoldersRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**envelope_ids** | **Array<String>** | | [optional]
|
|
7
|
+
**from_folder_id** | **String** | The folder ID the envelope is being moved from. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# DocuSign_eSign::ForgottenPasswordInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**forgotten_password_answer1** | **String** | The answer to the first forgotten password challenge question. | [optional]
|
|
7
|
+
**forgotten_password_answer2** | **String** | The answer to the second forgotten password challenge question. | [optional]
|
|
8
|
+
**forgotten_password_answer3** | **String** | The answer to the third forgotten password challenge question. | [optional]
|
|
9
|
+
**forgotten_password_answer4** | **String** | The answer to the fourth forgotten password challenge question. | [optional]
|
|
10
|
+
**forgotten_password_question1** | **String** | The first challenge question presented to a user who has forgotten their password. | [optional]
|
|
11
|
+
**forgotten_password_question2** | **String** | The second challenge question presented to a user who has forgotten their password. | [optional]
|
|
12
|
+
**forgotten_password_question3** | **String** | The third challenge question presented to a user who has forgotten their password. | [optional]
|
|
13
|
+
**forgotten_password_question4** | **String** | The fourth challenge question presented to a user who has forgotten their password. | [optional]
|
|
14
|
+
|
|
15
|
+
|
data/docs/FormulaTab.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# DocuSign_eSign::FormulaTab
|
|
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
|
+
**formula** | **String** | The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] | [optional]
|
|
26
|
+
**is_payment_amount** | **String** | When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. | [optional]
|
|
27
|
+
**italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
|
|
28
|
+
**locked** | **String** | When set to **true**, the signer cannot change the data of the custom tab. | [optional]
|
|
29
|
+
**max_length** | **Integer** | An optional value that describes the maximum length of the property when the property is a string. | [optional]
|
|
30
|
+
**merge_field** | [**MergeField**](MergeField.md) | | [optional]
|
|
31
|
+
**name** | **String** | | [optional]
|
|
32
|
+
**original_value** | **String** | The initial value of the tab when it was sent to the recipient. | [optional]
|
|
33
|
+
**page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
|
|
34
|
+
**payment_details** | [**PaymentDetails**](PaymentDetails.md) | | [optional]
|
|
35
|
+
**recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
|
|
36
|
+
**require_all** | **String** | When set to **true** and shared is true, information must be entered in this field to complete the envelope. | [optional]
|
|
37
|
+
**required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
|
|
38
|
+
**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]
|
|
39
|
+
**round_decimal_places** | **String** | | [optional]
|
|
40
|
+
**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]
|
|
41
|
+
**shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
|
|
42
|
+
**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]
|
|
43
|
+
**tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
|
|
44
|
+
**tab_label** | **String** | The label string associated with the tab. | [optional]
|
|
45
|
+
**tab_order** | **String** | | [optional]
|
|
46
|
+
**template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
|
|
47
|
+
**template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
|
|
48
|
+
**underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
|
|
49
|
+
**validation_message** | **String** | The message displayed if the custom tab fails input validation (either custom of embedded). | [optional]
|
|
50
|
+
**validation_pattern** | **String** | A regular expressionn used to validate input for the tab. | [optional]
|
|
51
|
+
**value** | **String** | Specifies the value of the tab. | [optional]
|
|
52
|
+
**width** | **Integer** | Width of the tab in pixels. | [optional]
|
|
53
|
+
**x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
54
|
+
**y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
55
|
+
|
|
56
|
+
|
data/docs/FullName.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# DocuSign_eSign::FullName
|
|
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
|
+
**conditional_parent_label** | **String** | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | [optional]
|
|
16
|
+
**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]
|
|
17
|
+
**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]
|
|
18
|
+
**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]
|
|
19
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
20
|
+
**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]
|
|
21
|
+
**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]
|
|
22
|
+
**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]
|
|
23
|
+
**italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
|
|
24
|
+
**merge_field** | [**MergeField**](MergeField.md) | | [optional]
|
|
25
|
+
**name** | **String** | | [optional]
|
|
26
|
+
**page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
|
|
27
|
+
**recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
|
|
28
|
+
**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]
|
|
29
|
+
**tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
|
|
30
|
+
**tab_label** | **String** | The label string associated with the tab. | [optional]
|
|
31
|
+
**tab_order** | **String** | | [optional]
|
|
32
|
+
**template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
|
|
33
|
+
**template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
|
|
34
|
+
**underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
|
|
35
|
+
**x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
36
|
+
**y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
37
|
+
|
|
38
|
+
|
data/docs/Group.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# DocuSign_eSign::Group
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
7
|
+
**group_id** | **String** | The DocuSign group ID for the group. | [optional]
|
|
8
|
+
**group_name** | **String** | The name of the group. | [optional]
|
|
9
|
+
**group_type** | **String** | The group type. | [optional]
|
|
10
|
+
**permission_profile_id** | **String** | The ID of the permission profile associated with the group. | [optional]
|
|
11
|
+
**users** | [**Array<UserInfo>**](UserInfo.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# DocuSign_eSign::GroupInformation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**end_position** | **String** | The last position in the result set. | [optional]
|
|
7
|
+
**groups** | [**Array<Group>**](Group.md) | A collection group objects containing information about the groups returned. | [optional]
|
|
8
|
+
**next_uri** | **String** | The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. | [optional]
|
|
9
|
+
**previous_uri** | **String** | The postal code for the billing address. | [optional]
|
|
10
|
+
**result_set_size** | **String** | The number of results returned in this response. | [optional]
|
|
11
|
+
**start_position** | **String** | Starting position of the current result set. | [optional]
|
|
12
|
+
**total_set_size** | **String** | The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. | [optional]
|
|
13
|
+
|
|
14
|
+
|
data/docs/GroupsApi.md
ADDED
|
@@ -0,0 +1,552 @@
|
|
|
1
|
+
# DocuSign_eSign::GroupsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://www.docusign.net/restapi*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_groups**](GroupsApi.md#create_groups) | **POST** /v2/accounts/{accountId}/groups | Creates one or more groups for the account.
|
|
8
|
+
[**delete_brands**](GroupsApi.md#delete_brands) | **DELETE** /v2/accounts/{accountId}/groups/{groupId}/brands | Deletes brand information from the requested group.
|
|
9
|
+
[**delete_group_users**](GroupsApi.md#delete_group_users) | **DELETE** /v2/accounts/{accountId}/groups/{groupId}/users | Deletes one or more users from a gro
|
|
10
|
+
[**delete_groups**](GroupsApi.md#delete_groups) | **DELETE** /v2/accounts/{accountId}/groups | Deletes an existing user group.
|
|
11
|
+
[**get_brands**](GroupsApi.md#get_brands) | **GET** /v2/accounts/{accountId}/groups/{groupId}/brands | Gets group brand ID Information.
|
|
12
|
+
[**list_group_users**](GroupsApi.md#list_group_users) | **GET** /v2/accounts/{accountId}/groups/{groupId}/users | Gets a list of users in a group.
|
|
13
|
+
[**list_groups**](GroupsApi.md#list_groups) | **GET** /v2/accounts/{accountId}/groups | Gets information about groups associated with the account.
|
|
14
|
+
[**update_brands**](GroupsApi.md#update_brands) | **PUT** /v2/accounts/{accountId}/groups/{groupId}/brands | Adds group brand ID information to a group.
|
|
15
|
+
[**update_group_users**](GroupsApi.md#update_group_users) | **PUT** /v2/accounts/{accountId}/groups/{groupId}/users | Adds one or more users to an existing group.
|
|
16
|
+
[**update_groups**](GroupsApi.md#update_groups) | **PUT** /v2/accounts/{accountId}/groups | Updates the group information for a group.
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
# **create_groups**
|
|
20
|
+
> GroupInformation create_groups(account_id, opts)
|
|
21
|
+
|
|
22
|
+
Creates one or more groups for the account.
|
|
23
|
+
|
|
24
|
+
Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.
|
|
25
|
+
|
|
26
|
+
### Example
|
|
27
|
+
```ruby
|
|
28
|
+
# load the gem
|
|
29
|
+
require 'docusign_esign'
|
|
30
|
+
|
|
31
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
32
|
+
|
|
33
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
34
|
+
|
|
35
|
+
opts = {
|
|
36
|
+
group_information: DocuSign_eSign::GroupInformation.new # GroupInformation |
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
#Creates one or more groups for the account.
|
|
41
|
+
result = api_instance.create_groups(account_id, opts)
|
|
42
|
+
p result
|
|
43
|
+
rescue DocuSign_eSign::ApiError => e
|
|
44
|
+
puts "Exception when calling GroupsApi->create_groups: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Parameters
|
|
49
|
+
|
|
50
|
+
Name | Type | Description | Notes
|
|
51
|
+
------------- | ------------- | ------------- | -------------
|
|
52
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
53
|
+
**group_information** | [**GroupInformation**](GroupInformation.md)| | [optional]
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
[**GroupInformation**](GroupInformation.md)
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
No authorization required
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: Not defined
|
|
66
|
+
- **Accept**: application/json
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
# **delete_brands**
|
|
71
|
+
> BrandsResponse delete_brands(account_id, group_id, opts)
|
|
72
|
+
|
|
73
|
+
Deletes brand information from the requested group.
|
|
74
|
+
|
|
75
|
+
Deletes brand information from the requested group.
|
|
76
|
+
|
|
77
|
+
### Example
|
|
78
|
+
```ruby
|
|
79
|
+
# load the gem
|
|
80
|
+
require 'docusign_esign'
|
|
81
|
+
|
|
82
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
83
|
+
|
|
84
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
85
|
+
|
|
86
|
+
group_id = "group_id_example" # String | The ID of the group being accessed.
|
|
87
|
+
|
|
88
|
+
opts = {
|
|
89
|
+
brands_request: DocuSign_eSign::BrandsRequest.new # BrandsRequest |
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
begin
|
|
93
|
+
#Deletes brand information from the requested group.
|
|
94
|
+
result = api_instance.delete_brands(account_id, group_id, opts)
|
|
95
|
+
p result
|
|
96
|
+
rescue DocuSign_eSign::ApiError => e
|
|
97
|
+
puts "Exception when calling GroupsApi->delete_brands: #{e}"
|
|
98
|
+
end
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Parameters
|
|
102
|
+
|
|
103
|
+
Name | Type | Description | Notes
|
|
104
|
+
------------- | ------------- | ------------- | -------------
|
|
105
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
106
|
+
**group_id** | **String**| The ID of the group being accessed. |
|
|
107
|
+
**brands_request** | [**BrandsRequest**](BrandsRequest.md)| | [optional]
|
|
108
|
+
|
|
109
|
+
### Return type
|
|
110
|
+
|
|
111
|
+
[**BrandsResponse**](BrandsResponse.md)
|
|
112
|
+
|
|
113
|
+
### Authorization
|
|
114
|
+
|
|
115
|
+
No authorization required
|
|
116
|
+
|
|
117
|
+
### HTTP request headers
|
|
118
|
+
|
|
119
|
+
- **Content-Type**: Not defined
|
|
120
|
+
- **Accept**: application/json
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
# **delete_group_users**
|
|
125
|
+
> UsersResponse delete_group_users(account_id, group_id, opts)
|
|
126
|
+
|
|
127
|
+
Deletes one or more users from a gro
|
|
128
|
+
|
|
129
|
+
Deletes one or more users from a group.
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
```ruby
|
|
133
|
+
# load the gem
|
|
134
|
+
require 'docusign_esign'
|
|
135
|
+
|
|
136
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
137
|
+
|
|
138
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
139
|
+
|
|
140
|
+
group_id = "group_id_example" # String | The ID of the group being accessed.
|
|
141
|
+
|
|
142
|
+
opts = {
|
|
143
|
+
user_info_list: DocuSign_eSign::UserInfoList.new # UserInfoList |
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
begin
|
|
147
|
+
#Deletes one or more users from a gro
|
|
148
|
+
result = api_instance.delete_group_users(account_id, group_id, opts)
|
|
149
|
+
p result
|
|
150
|
+
rescue DocuSign_eSign::ApiError => e
|
|
151
|
+
puts "Exception when calling GroupsApi->delete_group_users: #{e}"
|
|
152
|
+
end
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
Name | Type | Description | Notes
|
|
158
|
+
------------- | ------------- | ------------- | -------------
|
|
159
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
160
|
+
**group_id** | **String**| The ID of the group being accessed. |
|
|
161
|
+
**user_info_list** | [**UserInfoList**](UserInfoList.md)| | [optional]
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
[**UsersResponse**](UsersResponse.md)
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
No authorization required
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: Not defined
|
|
174
|
+
- **Accept**: application/json
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
# **delete_groups**
|
|
179
|
+
> GroupInformation delete_groups(account_id, opts)
|
|
180
|
+
|
|
181
|
+
Deletes an existing user group.
|
|
182
|
+
|
|
183
|
+
Deletes an existing user group.
|
|
184
|
+
|
|
185
|
+
### Example
|
|
186
|
+
```ruby
|
|
187
|
+
# load the gem
|
|
188
|
+
require 'docusign_esign'
|
|
189
|
+
|
|
190
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
191
|
+
|
|
192
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
193
|
+
|
|
194
|
+
opts = {
|
|
195
|
+
group_information: DocuSign_eSign::GroupInformation.new # GroupInformation |
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
begin
|
|
199
|
+
#Deletes an existing user group.
|
|
200
|
+
result = api_instance.delete_groups(account_id, opts)
|
|
201
|
+
p result
|
|
202
|
+
rescue DocuSign_eSign::ApiError => e
|
|
203
|
+
puts "Exception when calling GroupsApi->delete_groups: #{e}"
|
|
204
|
+
end
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Parameters
|
|
208
|
+
|
|
209
|
+
Name | Type | Description | Notes
|
|
210
|
+
------------- | ------------- | ------------- | -------------
|
|
211
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
212
|
+
**group_information** | [**GroupInformation**](GroupInformation.md)| | [optional]
|
|
213
|
+
|
|
214
|
+
### Return type
|
|
215
|
+
|
|
216
|
+
[**GroupInformation**](GroupInformation.md)
|
|
217
|
+
|
|
218
|
+
### Authorization
|
|
219
|
+
|
|
220
|
+
No authorization required
|
|
221
|
+
|
|
222
|
+
### HTTP request headers
|
|
223
|
+
|
|
224
|
+
- **Content-Type**: Not defined
|
|
225
|
+
- **Accept**: application/json
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
# **get_brands**
|
|
230
|
+
> BrandsResponse get_brands(account_id, group_id)
|
|
231
|
+
|
|
232
|
+
Gets group brand ID Information.
|
|
233
|
+
|
|
234
|
+
Retrieves information about the brands associated with the requested group.
|
|
235
|
+
|
|
236
|
+
### Example
|
|
237
|
+
```ruby
|
|
238
|
+
# load the gem
|
|
239
|
+
require 'docusign_esign'
|
|
240
|
+
|
|
241
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
242
|
+
|
|
243
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
244
|
+
|
|
245
|
+
group_id = "group_id_example" # String | The ID of the group being accessed.
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
begin
|
|
249
|
+
#Gets group brand ID Information.
|
|
250
|
+
result = api_instance.get_brands(account_id, group_id)
|
|
251
|
+
p result
|
|
252
|
+
rescue DocuSign_eSign::ApiError => e
|
|
253
|
+
puts "Exception when calling GroupsApi->get_brands: #{e}"
|
|
254
|
+
end
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
### Parameters
|
|
258
|
+
|
|
259
|
+
Name | Type | Description | Notes
|
|
260
|
+
------------- | ------------- | ------------- | -------------
|
|
261
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
262
|
+
**group_id** | **String**| The ID of the group being accessed. |
|
|
263
|
+
|
|
264
|
+
### Return type
|
|
265
|
+
|
|
266
|
+
[**BrandsResponse**](BrandsResponse.md)
|
|
267
|
+
|
|
268
|
+
### Authorization
|
|
269
|
+
|
|
270
|
+
No authorization required
|
|
271
|
+
|
|
272
|
+
### HTTP request headers
|
|
273
|
+
|
|
274
|
+
- **Content-Type**: Not defined
|
|
275
|
+
- **Accept**: application/json
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
# **list_group_users**
|
|
280
|
+
> UsersResponse list_group_users(account_id, group_id, opts)
|
|
281
|
+
|
|
282
|
+
Gets a list of users in a group.
|
|
283
|
+
|
|
284
|
+
Retrieves a list of users in a group.
|
|
285
|
+
|
|
286
|
+
### Example
|
|
287
|
+
```ruby
|
|
288
|
+
# load the gem
|
|
289
|
+
require 'docusign_esign'
|
|
290
|
+
|
|
291
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
292
|
+
|
|
293
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
294
|
+
|
|
295
|
+
group_id = "group_id_example" # String | The ID of the group being accessed.
|
|
296
|
+
|
|
297
|
+
opts = {
|
|
298
|
+
count: "count_example", # String | Number of records to return. The number must be greater than 1 and less than or equal to 100.
|
|
299
|
+
start_position: "start_position_example" # String | Starting value for the list.
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
begin
|
|
303
|
+
#Gets a list of users in a group.
|
|
304
|
+
result = api_instance.list_group_users(account_id, group_id, opts)
|
|
305
|
+
p result
|
|
306
|
+
rescue DocuSign_eSign::ApiError => e
|
|
307
|
+
puts "Exception when calling GroupsApi->list_group_users: #{e}"
|
|
308
|
+
end
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Parameters
|
|
312
|
+
|
|
313
|
+
Name | Type | Description | Notes
|
|
314
|
+
------------- | ------------- | ------------- | -------------
|
|
315
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
316
|
+
**group_id** | **String**| The ID of the group being accessed. |
|
|
317
|
+
**count** | **String**| Number of records to return. The number must be greater than 1 and less than or equal to 100. | [optional]
|
|
318
|
+
**start_position** | **String**| Starting value for the list. | [optional]
|
|
319
|
+
|
|
320
|
+
### Return type
|
|
321
|
+
|
|
322
|
+
[**UsersResponse**](UsersResponse.md)
|
|
323
|
+
|
|
324
|
+
### Authorization
|
|
325
|
+
|
|
326
|
+
No authorization required
|
|
327
|
+
|
|
328
|
+
### HTTP request headers
|
|
329
|
+
|
|
330
|
+
- **Content-Type**: Not defined
|
|
331
|
+
- **Accept**: application/json
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
# **list_groups**
|
|
336
|
+
> GroupInformation list_groups(account_id, opts)
|
|
337
|
+
|
|
338
|
+
Gets information about groups associated with the account.
|
|
339
|
+
|
|
340
|
+
Retrieves information about groups associated with the account.
|
|
341
|
+
|
|
342
|
+
### Example
|
|
343
|
+
```ruby
|
|
344
|
+
# load the gem
|
|
345
|
+
require 'docusign_esign'
|
|
346
|
+
|
|
347
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
348
|
+
|
|
349
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
350
|
+
|
|
351
|
+
opts = {
|
|
352
|
+
count: "count_example", # String | Number of records to return. The number must be greater than 1 and less than or equal to 100.
|
|
353
|
+
group_name: "group_name_example", # String | Filters the groups returned by the group name or a sub-string of group name.
|
|
354
|
+
group_type: "group_type_example", # String |
|
|
355
|
+
search_text: "search_text_example", # String |
|
|
356
|
+
start_position: "start_position_example" # String | Starting value for the list.
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
begin
|
|
360
|
+
#Gets information about groups associated with the account.
|
|
361
|
+
result = api_instance.list_groups(account_id, opts)
|
|
362
|
+
p result
|
|
363
|
+
rescue DocuSign_eSign::ApiError => e
|
|
364
|
+
puts "Exception when calling GroupsApi->list_groups: #{e}"
|
|
365
|
+
end
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
### Parameters
|
|
369
|
+
|
|
370
|
+
Name | Type | Description | Notes
|
|
371
|
+
------------- | ------------- | ------------- | -------------
|
|
372
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
373
|
+
**count** | **String**| Number of records to return. The number must be greater than 1 and less than or equal to 100. | [optional]
|
|
374
|
+
**group_name** | **String**| Filters the groups returned by the group name or a sub-string of group name. | [optional]
|
|
375
|
+
**group_type** | **String**| | [optional]
|
|
376
|
+
**search_text** | **String**| | [optional]
|
|
377
|
+
**start_position** | **String**| Starting value for the list. | [optional]
|
|
378
|
+
|
|
379
|
+
### Return type
|
|
380
|
+
|
|
381
|
+
[**GroupInformation**](GroupInformation.md)
|
|
382
|
+
|
|
383
|
+
### Authorization
|
|
384
|
+
|
|
385
|
+
No authorization required
|
|
386
|
+
|
|
387
|
+
### HTTP request headers
|
|
388
|
+
|
|
389
|
+
- **Content-Type**: Not defined
|
|
390
|
+
- **Accept**: application/json
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
# **update_brands**
|
|
395
|
+
> BrandsResponse update_brands(account_id, group_id, opts)
|
|
396
|
+
|
|
397
|
+
Adds group brand ID information to a group.
|
|
398
|
+
|
|
399
|
+
Adds group brand ID information to a group.
|
|
400
|
+
|
|
401
|
+
### Example
|
|
402
|
+
```ruby
|
|
403
|
+
# load the gem
|
|
404
|
+
require 'docusign_esign'
|
|
405
|
+
|
|
406
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
407
|
+
|
|
408
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
409
|
+
|
|
410
|
+
group_id = "group_id_example" # String | The ID of the group being accessed.
|
|
411
|
+
|
|
412
|
+
opts = {
|
|
413
|
+
brands_request: DocuSign_eSign::BrandsRequest.new # BrandsRequest |
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
begin
|
|
417
|
+
#Adds group brand ID information to a group.
|
|
418
|
+
result = api_instance.update_brands(account_id, group_id, opts)
|
|
419
|
+
p result
|
|
420
|
+
rescue DocuSign_eSign::ApiError => e
|
|
421
|
+
puts "Exception when calling GroupsApi->update_brands: #{e}"
|
|
422
|
+
end
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
### Parameters
|
|
426
|
+
|
|
427
|
+
Name | Type | Description | Notes
|
|
428
|
+
------------- | ------------- | ------------- | -------------
|
|
429
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
430
|
+
**group_id** | **String**| The ID of the group being accessed. |
|
|
431
|
+
**brands_request** | [**BrandsRequest**](BrandsRequest.md)| | [optional]
|
|
432
|
+
|
|
433
|
+
### Return type
|
|
434
|
+
|
|
435
|
+
[**BrandsResponse**](BrandsResponse.md)
|
|
436
|
+
|
|
437
|
+
### Authorization
|
|
438
|
+
|
|
439
|
+
No authorization required
|
|
440
|
+
|
|
441
|
+
### HTTP request headers
|
|
442
|
+
|
|
443
|
+
- **Content-Type**: Not defined
|
|
444
|
+
- **Accept**: application/json
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
# **update_group_users**
|
|
449
|
+
> UsersResponse update_group_users(account_id, group_id, opts)
|
|
450
|
+
|
|
451
|
+
Adds one or more users to an existing group.
|
|
452
|
+
|
|
453
|
+
Adds one or more users to an existing group.
|
|
454
|
+
|
|
455
|
+
### Example
|
|
456
|
+
```ruby
|
|
457
|
+
# load the gem
|
|
458
|
+
require 'docusign_esign'
|
|
459
|
+
|
|
460
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
461
|
+
|
|
462
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
463
|
+
|
|
464
|
+
group_id = "group_id_example" # String | The ID of the group being accessed.
|
|
465
|
+
|
|
466
|
+
opts = {
|
|
467
|
+
user_info_list: DocuSign_eSign::UserInfoList.new # UserInfoList |
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
begin
|
|
471
|
+
#Adds one or more users to an existing group.
|
|
472
|
+
result = api_instance.update_group_users(account_id, group_id, opts)
|
|
473
|
+
p result
|
|
474
|
+
rescue DocuSign_eSign::ApiError => e
|
|
475
|
+
puts "Exception when calling GroupsApi->update_group_users: #{e}"
|
|
476
|
+
end
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
### Parameters
|
|
480
|
+
|
|
481
|
+
Name | Type | Description | Notes
|
|
482
|
+
------------- | ------------- | ------------- | -------------
|
|
483
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
484
|
+
**group_id** | **String**| The ID of the group being accessed. |
|
|
485
|
+
**user_info_list** | [**UserInfoList**](UserInfoList.md)| | [optional]
|
|
486
|
+
|
|
487
|
+
### Return type
|
|
488
|
+
|
|
489
|
+
[**UsersResponse**](UsersResponse.md)
|
|
490
|
+
|
|
491
|
+
### Authorization
|
|
492
|
+
|
|
493
|
+
No authorization required
|
|
494
|
+
|
|
495
|
+
### HTTP request headers
|
|
496
|
+
|
|
497
|
+
- **Content-Type**: Not defined
|
|
498
|
+
- **Accept**: application/json
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
# **update_groups**
|
|
503
|
+
> GroupInformation update_groups(account_id, opts)
|
|
504
|
+
|
|
505
|
+
Updates the group information for a group.
|
|
506
|
+
|
|
507
|
+
Updates the group name and modifies, or sets, the permission profile for the group.
|
|
508
|
+
|
|
509
|
+
### Example
|
|
510
|
+
```ruby
|
|
511
|
+
# load the gem
|
|
512
|
+
require 'docusign_esign'
|
|
513
|
+
|
|
514
|
+
api_instance = DocuSign_eSign::GroupsApi.new
|
|
515
|
+
|
|
516
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
517
|
+
|
|
518
|
+
opts = {
|
|
519
|
+
group_information: DocuSign_eSign::GroupInformation.new # GroupInformation |
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
begin
|
|
523
|
+
#Updates the group information for a group.
|
|
524
|
+
result = api_instance.update_groups(account_id, opts)
|
|
525
|
+
p result
|
|
526
|
+
rescue DocuSign_eSign::ApiError => e
|
|
527
|
+
puts "Exception when calling GroupsApi->update_groups: #{e}"
|
|
528
|
+
end
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
### Parameters
|
|
532
|
+
|
|
533
|
+
Name | Type | Description | Notes
|
|
534
|
+
------------- | ------------- | ------------- | -------------
|
|
535
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
536
|
+
**group_information** | [**GroupInformation**](GroupInformation.md)| | [optional]
|
|
537
|
+
|
|
538
|
+
### Return type
|
|
539
|
+
|
|
540
|
+
[**GroupInformation**](GroupInformation.md)
|
|
541
|
+
|
|
542
|
+
### Authorization
|
|
543
|
+
|
|
544
|
+
No authorization required
|
|
545
|
+
|
|
546
|
+
### HTTP request headers
|
|
547
|
+
|
|
548
|
+
- **Content-Type**: Not defined
|
|
549
|
+
- **Accept**: application/json
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|