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,14 @@
|
|
|
1
|
+
# DocuSign_eSign::UsersResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**end_position** | **String** | The last position in the result set. | [optional]
|
|
7
|
+
**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]
|
|
8
|
+
**previous_uri** | **String** | The postal code for the billing address. | [optional]
|
|
9
|
+
**result_set_size** | **String** | The number of results returned in this response. | [optional]
|
|
10
|
+
**start_position** | **String** | Starting position of the current result set. | [optional]
|
|
11
|
+
**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]
|
|
12
|
+
**users** | [**Array<UserInfo>**](UserInfo.md) | | [optional]
|
|
13
|
+
|
|
14
|
+
|
data/docs/View.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# DocuSign_eSign::View
|
|
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
|
+
**button_text** | **String** | | [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
|
+
**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]
|
|
20
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [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** | **Integer** | Height of the tab in pixels. | [optional]
|
|
25
|
+
**italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
|
|
26
|
+
**merge_field** | [**MergeField**](MergeField.md) | | [optional]
|
|
27
|
+
**page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
|
|
28
|
+
**recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
|
|
29
|
+
**required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
|
|
30
|
+
**required_read** | **String** | | [optional]
|
|
31
|
+
**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]
|
|
32
|
+
**tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
|
|
33
|
+
**tab_label** | **String** | The label string associated with the tab. | [optional]
|
|
34
|
+
**tab_order** | **String** | | [optional]
|
|
35
|
+
**template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
|
|
36
|
+
**template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
|
|
37
|
+
**underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
|
|
38
|
+
**width** | **Integer** | Width of the tab in pixels. | [optional]
|
|
39
|
+
**x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
40
|
+
**y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
41
|
+
|
|
42
|
+
|
data/docs/ViewUrl.md
ADDED
data/docs/Workspace.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# DocuSign_eSign::Workspace
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**billable_account_id** | **String** | | [optional]
|
|
7
|
+
**created** | **String** | | [optional]
|
|
8
|
+
**created_by_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
|
|
9
|
+
**last_modified** | **String** | Utc date and time the comment was last updated (can only be done by creator.) | [optional]
|
|
10
|
+
**last_modified_by_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
|
|
11
|
+
**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]
|
|
12
|
+
**workspace_base_url** | **String** | The relative URL that may be used to access the workspace. | [optional]
|
|
13
|
+
**workspace_description** | **String** | Text describing the purpose of the workspace. | [optional]
|
|
14
|
+
**workspace_id** | **String** | The id of the workspace, always populated. | [optional]
|
|
15
|
+
**workspace_name** | **String** | The name of the workspace. | [optional]
|
|
16
|
+
**workspace_uri** | **String** | The relative URI that may be used to access the workspace. | [optional]
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# DocuSign_eSign::WorkspaceFolderContents
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**end_position** | **String** | The last position in the result set. | [optional]
|
|
7
|
+
**folder** | [**WorkspaceItem**](WorkspaceItem.md) | | [optional]
|
|
8
|
+
**items** | [**Array<WorkspaceItem>**](WorkspaceItem.md) | | [optional]
|
|
9
|
+
**parent_folders** | [**Array<WorkspaceItem>**](WorkspaceItem.md) | | [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
|
+
**workspace_id** | **String** | The id of the workspace, always populated. | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# DocuSign_eSign::WorkspaceItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**caller_authorization** | [**WorkspaceUserAuthorization**](WorkspaceUserAuthorization.md) | | [optional]
|
|
7
|
+
**content_type** | **String** | | [optional]
|
|
8
|
+
**created** | **String** | The UTC DateTime when the workspace item was created. | [optional]
|
|
9
|
+
**created_by_id** | **String** | | [optional]
|
|
10
|
+
**created_by_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
|
|
11
|
+
**extension** | **String** | | [optional]
|
|
12
|
+
**file_size** | **String** | | [optional]
|
|
13
|
+
**file_uri** | **String** | | [optional]
|
|
14
|
+
**id** | **String** | | [optional]
|
|
15
|
+
**is_public** | **String** | If true, this supersedes need for bit mask permission with workspaceUserAuthorization | [optional]
|
|
16
|
+
**last_modified** | **String** | | [optional]
|
|
17
|
+
**last_modified_by_id** | **String** | Utc date and time the comment was last updated (can only be done by creator) | [optional]
|
|
18
|
+
**last_modified_by_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
|
|
19
|
+
**name** | **String** | A simple string description of the item, such as a file name or a folder name. | [optional]
|
|
20
|
+
**page_count** | **String** | | [optional]
|
|
21
|
+
**parent_folder_id** | **String** | The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder. | [optional]
|
|
22
|
+
**parent_folder_uri** | **String** | | [optional]
|
|
23
|
+
**type** | **String** | The type of the workspace item. Valid values are file, folder. | [optional]
|
|
24
|
+
**uri** | **String** | | [optional]
|
|
25
|
+
|
|
26
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# DocuSign_eSign::WorkspaceList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**end_position** | **String** | The last position in the result set. | [optional]
|
|
7
|
+
**result_set_size** | **String** | The number of results returned in this response. | [optional]
|
|
8
|
+
**start_position** | **String** | Starting position of the current result set. | [optional]
|
|
9
|
+
**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]
|
|
10
|
+
**workspaces** | [**Array<Workspace>**](Workspace.md) | A list of workspaces. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# DocuSign_eSign::WorkspaceUser
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**account_id** | **String** | The account ID associated with the envelope. | [optional]
|
|
7
|
+
**account_name** | **String** | The name of the account that the workspace user belongs to. | [optional]
|
|
8
|
+
**active_since** | **String** | | [optional]
|
|
9
|
+
**created** | **String** | The UTC DateTime when the workspace user was created. | [optional]
|
|
10
|
+
**created_by_id** | **String** | | [optional]
|
|
11
|
+
**email** | **String** | | [optional]
|
|
12
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
13
|
+
**last_modified** | **String** | Utc date and time the comment was last updated (can only be done by creator.) | [optional]
|
|
14
|
+
**last_modified_by_id** | **String** | | [optional]
|
|
15
|
+
**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]
|
|
16
|
+
**type** | **String** | Type of the user. Valid values: type_owner, type_participant. | [optional]
|
|
17
|
+
**user_id** | **String** | | [optional]
|
|
18
|
+
**user_name** | **String** | | [optional]
|
|
19
|
+
**workspace_id** | **String** | | [optional]
|
|
20
|
+
**workspace_user_base_url** | **String** | The relative URI that may be used to access a workspace user. | [optional]
|
|
21
|
+
**workspace_user_id** | **String** | | [optional]
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# DocuSign_eSign::WorkspaceUserAuthorization
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**can_delete** | **String** | | [optional]
|
|
7
|
+
**can_move** | **String** | | [optional]
|
|
8
|
+
**can_transact** | **String** | | [optional]
|
|
9
|
+
**can_view** | **String** | | [optional]
|
|
10
|
+
**created** | **String** | The UTC DateTime when the workspace user authorization was created. | [optional]
|
|
11
|
+
**created_by_id** | **String** | | [optional]
|
|
12
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
13
|
+
**modified** | **String** | | [optional]
|
|
14
|
+
**modified_by_id** | **String** | | [optional]
|
|
15
|
+
**workspace_user_id** | **String** | | [optional]
|
|
16
|
+
**workspace_user_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,630 @@
|
|
|
1
|
+
# DocuSign_eSign::WorkspacesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://www.docusign.net/restapi*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_workspace**](WorkspacesApi.md#create_workspace) | **POST** /v2/accounts/{accountId}/workspaces | Create a Workspace
|
|
8
|
+
[**create_workspace_file**](WorkspacesApi.md#create_workspace_file) | **POST** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files | Creates a workspace file.
|
|
9
|
+
[**delete_workspace**](WorkspacesApi.md#delete_workspace) | **DELETE** /v2/accounts/{accountId}/workspaces/{workspaceId} | Delete Workspace
|
|
10
|
+
[**delete_workspace_folder_items**](WorkspacesApi.md#delete_workspace_folder_items) | **DELETE** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId} | Deletes workspace one or more specific files/folders from the given folder or root.
|
|
11
|
+
[**get_workspace**](WorkspacesApi.md#get_workspace) | **GET** /v2/accounts/{accountId}/workspaces/{workspaceId} | Get Workspace
|
|
12
|
+
[**get_workspace_file**](WorkspacesApi.md#get_workspace_file) | **GET** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId} | Get Workspace File
|
|
13
|
+
[**list_workspace_file_pages**](WorkspacesApi.md#list_workspace_file_pages) | **GET** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages | List File Pages
|
|
14
|
+
[**list_workspace_folder_items**](WorkspacesApi.md#list_workspace_folder_items) | **GET** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId} | List Workspace Folder Contents
|
|
15
|
+
[**list_workspaces**](WorkspacesApi.md#list_workspaces) | **GET** /v2/accounts/{accountId}/workspaces | List Workspaces
|
|
16
|
+
[**update_workspace**](WorkspacesApi.md#update_workspace) | **PUT** /v2/accounts/{accountId}/workspaces/{workspaceId} | Update Workspace
|
|
17
|
+
[**update_workspace_file**](WorkspacesApi.md#update_workspace_file) | **PUT** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId} | Update Workspace File Metadata
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
# **create_workspace**
|
|
21
|
+
> Workspace create_workspace(account_id, opts)
|
|
22
|
+
|
|
23
|
+
Create a Workspace
|
|
24
|
+
|
|
25
|
+
Creates a new workspace.
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
```ruby
|
|
29
|
+
# load the gem
|
|
30
|
+
require 'docusign_esign'
|
|
31
|
+
|
|
32
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
33
|
+
|
|
34
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
35
|
+
|
|
36
|
+
opts = {
|
|
37
|
+
workspace: DocuSign_eSign::Workspace.new # Workspace |
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
#Create a Workspace
|
|
42
|
+
result = api_instance.create_workspace(account_id, opts)
|
|
43
|
+
p result
|
|
44
|
+
rescue DocuSign_eSign::ApiError => e
|
|
45
|
+
puts "Exception when calling WorkspacesApi->create_workspace: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Parameters
|
|
50
|
+
|
|
51
|
+
Name | Type | Description | Notes
|
|
52
|
+
------------- | ------------- | ------------- | -------------
|
|
53
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
54
|
+
**workspace** | [**Workspace**](Workspace.md)| | [optional]
|
|
55
|
+
|
|
56
|
+
### Return type
|
|
57
|
+
|
|
58
|
+
[**Workspace**](Workspace.md)
|
|
59
|
+
|
|
60
|
+
### Authorization
|
|
61
|
+
|
|
62
|
+
No authorization required
|
|
63
|
+
|
|
64
|
+
### HTTP request headers
|
|
65
|
+
|
|
66
|
+
- **Content-Type**: Not defined
|
|
67
|
+
- **Accept**: application/json
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
# **create_workspace_file**
|
|
72
|
+
> WorkspaceItem create_workspace_file(account_id, folder_id, workspace_id)
|
|
73
|
+
|
|
74
|
+
Creates a workspace file.
|
|
75
|
+
|
|
76
|
+
### Example
|
|
77
|
+
```ruby
|
|
78
|
+
# load the gem
|
|
79
|
+
require 'docusign_esign'
|
|
80
|
+
|
|
81
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
82
|
+
|
|
83
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
84
|
+
|
|
85
|
+
folder_id = "folder_id_example" # String | The ID of the folder being accessed.
|
|
86
|
+
|
|
87
|
+
workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
begin
|
|
91
|
+
#Creates a workspace file.
|
|
92
|
+
result = api_instance.create_workspace_file(account_id, folder_id, workspace_id)
|
|
93
|
+
p result
|
|
94
|
+
rescue DocuSign_eSign::ApiError => e
|
|
95
|
+
puts "Exception when calling WorkspacesApi->create_workspace_file: #{e}"
|
|
96
|
+
end
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Parameters
|
|
100
|
+
|
|
101
|
+
Name | Type | Description | Notes
|
|
102
|
+
------------- | ------------- | ------------- | -------------
|
|
103
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
104
|
+
**folder_id** | **String**| The ID of the folder being accessed. |
|
|
105
|
+
**workspace_id** | **String**| Specifies the workspace ID GUID. |
|
|
106
|
+
|
|
107
|
+
### Return type
|
|
108
|
+
|
|
109
|
+
[**WorkspaceItem**](WorkspaceItem.md)
|
|
110
|
+
|
|
111
|
+
### Authorization
|
|
112
|
+
|
|
113
|
+
No authorization required
|
|
114
|
+
|
|
115
|
+
### HTTP request headers
|
|
116
|
+
|
|
117
|
+
- **Content-Type**: Not defined
|
|
118
|
+
- **Accept**: application/json
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
# **delete_workspace**
|
|
123
|
+
> Workspace delete_workspace(account_id, workspace_id)
|
|
124
|
+
|
|
125
|
+
Delete Workspace
|
|
126
|
+
|
|
127
|
+
Deletes an existing workspace (logically).
|
|
128
|
+
|
|
129
|
+
### Example
|
|
130
|
+
```ruby
|
|
131
|
+
# load the gem
|
|
132
|
+
require 'docusign_esign'
|
|
133
|
+
|
|
134
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
135
|
+
|
|
136
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
137
|
+
|
|
138
|
+
workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
begin
|
|
142
|
+
#Delete Workspace
|
|
143
|
+
result = api_instance.delete_workspace(account_id, workspace_id)
|
|
144
|
+
p result
|
|
145
|
+
rescue DocuSign_eSign::ApiError => e
|
|
146
|
+
puts "Exception when calling WorkspacesApi->delete_workspace: #{e}"
|
|
147
|
+
end
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Parameters
|
|
151
|
+
|
|
152
|
+
Name | Type | Description | Notes
|
|
153
|
+
------------- | ------------- | ------------- | -------------
|
|
154
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
155
|
+
**workspace_id** | **String**| Specifies the workspace ID GUID. |
|
|
156
|
+
|
|
157
|
+
### Return type
|
|
158
|
+
|
|
159
|
+
[**Workspace**](Workspace.md)
|
|
160
|
+
|
|
161
|
+
### Authorization
|
|
162
|
+
|
|
163
|
+
No authorization required
|
|
164
|
+
|
|
165
|
+
### HTTP request headers
|
|
166
|
+
|
|
167
|
+
- **Content-Type**: Not defined
|
|
168
|
+
- **Accept**: application/json
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
# **delete_workspace_folder_items**
|
|
173
|
+
> delete_workspace_folder_items(account_id, folder_id, workspace_id, opts)
|
|
174
|
+
|
|
175
|
+
Deletes workspace one or more specific files/folders from the given folder or root.
|
|
176
|
+
|
|
177
|
+
### Example
|
|
178
|
+
```ruby
|
|
179
|
+
# load the gem
|
|
180
|
+
require 'docusign_esign'
|
|
181
|
+
|
|
182
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
183
|
+
|
|
184
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
185
|
+
|
|
186
|
+
folder_id = "folder_id_example" # String | The ID of the folder being accessed.
|
|
187
|
+
|
|
188
|
+
workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
|
|
189
|
+
|
|
190
|
+
opts = {
|
|
191
|
+
workspace_item_list: DocuSign_eSign::WorkspaceItemList.new # WorkspaceItemList |
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
begin
|
|
195
|
+
#Deletes workspace one or more specific files/folders from the given folder or root.
|
|
196
|
+
api_instance.delete_workspace_folder_items(account_id, folder_id, workspace_id, opts)
|
|
197
|
+
rescue DocuSign_eSign::ApiError => e
|
|
198
|
+
puts "Exception when calling WorkspacesApi->delete_workspace_folder_items: #{e}"
|
|
199
|
+
end
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Parameters
|
|
203
|
+
|
|
204
|
+
Name | Type | Description | Notes
|
|
205
|
+
------------- | ------------- | ------------- | -------------
|
|
206
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
207
|
+
**folder_id** | **String**| The ID of the folder being accessed. |
|
|
208
|
+
**workspace_id** | **String**| Specifies the workspace ID GUID. |
|
|
209
|
+
**workspace_item_list** | [**WorkspaceItemList**](WorkspaceItemList.md)| | [optional]
|
|
210
|
+
|
|
211
|
+
### Return type
|
|
212
|
+
|
|
213
|
+
nil (empty response body)
|
|
214
|
+
|
|
215
|
+
### Authorization
|
|
216
|
+
|
|
217
|
+
No authorization required
|
|
218
|
+
|
|
219
|
+
### HTTP request headers
|
|
220
|
+
|
|
221
|
+
- **Content-Type**: Not defined
|
|
222
|
+
- **Accept**: application/json
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
# **get_workspace**
|
|
227
|
+
> Workspace get_workspace(account_id, workspace_id)
|
|
228
|
+
|
|
229
|
+
Get Workspace
|
|
230
|
+
|
|
231
|
+
Retrives properties about a workspace given a unique workspaceId.
|
|
232
|
+
|
|
233
|
+
### Example
|
|
234
|
+
```ruby
|
|
235
|
+
# load the gem
|
|
236
|
+
require 'docusign_esign'
|
|
237
|
+
|
|
238
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
239
|
+
|
|
240
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
241
|
+
|
|
242
|
+
workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
begin
|
|
246
|
+
#Get Workspace
|
|
247
|
+
result = api_instance.get_workspace(account_id, workspace_id)
|
|
248
|
+
p result
|
|
249
|
+
rescue DocuSign_eSign::ApiError => e
|
|
250
|
+
puts "Exception when calling WorkspacesApi->get_workspace: #{e}"
|
|
251
|
+
end
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### Parameters
|
|
255
|
+
|
|
256
|
+
Name | Type | Description | Notes
|
|
257
|
+
------------- | ------------- | ------------- | -------------
|
|
258
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
259
|
+
**workspace_id** | **String**| Specifies the workspace ID GUID. |
|
|
260
|
+
|
|
261
|
+
### Return type
|
|
262
|
+
|
|
263
|
+
[**Workspace**](Workspace.md)
|
|
264
|
+
|
|
265
|
+
### Authorization
|
|
266
|
+
|
|
267
|
+
No authorization required
|
|
268
|
+
|
|
269
|
+
### HTTP request headers
|
|
270
|
+
|
|
271
|
+
- **Content-Type**: Not defined
|
|
272
|
+
- **Accept**: application/json
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
# **get_workspace_file**
|
|
277
|
+
> get_workspace_file(account_id, file_id, folder_id, workspace_id, opts)
|
|
278
|
+
|
|
279
|
+
Get Workspace File
|
|
280
|
+
|
|
281
|
+
Retrieves a workspace file (the binary).
|
|
282
|
+
|
|
283
|
+
### Example
|
|
284
|
+
```ruby
|
|
285
|
+
# load the gem
|
|
286
|
+
require 'docusign_esign'
|
|
287
|
+
|
|
288
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
289
|
+
|
|
290
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
291
|
+
|
|
292
|
+
file_id = "file_id_example" # String | Specifies the room file ID GUID.
|
|
293
|
+
|
|
294
|
+
folder_id = "folder_id_example" # String | The ID of the folder being accessed.
|
|
295
|
+
|
|
296
|
+
workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
|
|
297
|
+
|
|
298
|
+
opts = {
|
|
299
|
+
is_download: "is_download_example", # String | When set to **true**, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. Default is **false**.
|
|
300
|
+
pdf_version: "pdf_version_example" # String | When set to **true** the file returned as a PDF.
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
begin
|
|
304
|
+
#Get Workspace File
|
|
305
|
+
api_instance.get_workspace_file(account_id, file_id, folder_id, workspace_id, opts)
|
|
306
|
+
rescue DocuSign_eSign::ApiError => e
|
|
307
|
+
puts "Exception when calling WorkspacesApi->get_workspace_file: #{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
|
+
**file_id** | **String**| Specifies the room file ID GUID. |
|
|
317
|
+
**folder_id** | **String**| The ID of the folder being accessed. |
|
|
318
|
+
**workspace_id** | **String**| Specifies the workspace ID GUID. |
|
|
319
|
+
**is_download** | **String**| When set to **true**, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. Default is **false**. | [optional]
|
|
320
|
+
**pdf_version** | **String**| When set to **true** the file returned as a PDF. | [optional]
|
|
321
|
+
|
|
322
|
+
### Return type
|
|
323
|
+
|
|
324
|
+
nil (empty response body)
|
|
325
|
+
|
|
326
|
+
### Authorization
|
|
327
|
+
|
|
328
|
+
No authorization required
|
|
329
|
+
|
|
330
|
+
### HTTP request headers
|
|
331
|
+
|
|
332
|
+
- **Content-Type**: Not defined
|
|
333
|
+
- **Accept**: application/json
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
# **list_workspace_file_pages**
|
|
338
|
+
> PageImages list_workspace_file_pages(account_id, file_id, folder_id, workspace_id, opts)
|
|
339
|
+
|
|
340
|
+
List File Pages
|
|
341
|
+
|
|
342
|
+
Retrieves a workspace file as rasterized pages.
|
|
343
|
+
|
|
344
|
+
### Example
|
|
345
|
+
```ruby
|
|
346
|
+
# load the gem
|
|
347
|
+
require 'docusign_esign'
|
|
348
|
+
|
|
349
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
350
|
+
|
|
351
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
352
|
+
|
|
353
|
+
file_id = "file_id_example" # String | Specifies the room file ID GUID.
|
|
354
|
+
|
|
355
|
+
folder_id = "folder_id_example" # String | The ID of the folder being accessed.
|
|
356
|
+
|
|
357
|
+
workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
|
|
358
|
+
|
|
359
|
+
opts = {
|
|
360
|
+
count: "count_example", # String | The maximum number of results to be returned by this request.
|
|
361
|
+
dpi: "dpi_example", # String | Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.
|
|
362
|
+
max_height: "max_height_example", # String | Sets the maximum height (in pixels) of the returned image.
|
|
363
|
+
max_width: "max_width_example", # String | Sets the maximum width (in pixels) of the returned image.
|
|
364
|
+
start_position: "start_position_example" # String | The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
begin
|
|
368
|
+
#List File Pages
|
|
369
|
+
result = api_instance.list_workspace_file_pages(account_id, file_id, folder_id, workspace_id, opts)
|
|
370
|
+
p result
|
|
371
|
+
rescue DocuSign_eSign::ApiError => e
|
|
372
|
+
puts "Exception when calling WorkspacesApi->list_workspace_file_pages: #{e}"
|
|
373
|
+
end
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
### Parameters
|
|
377
|
+
|
|
378
|
+
Name | Type | Description | Notes
|
|
379
|
+
------------- | ------------- | ------------- | -------------
|
|
380
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
381
|
+
**file_id** | **String**| Specifies the room file ID GUID. |
|
|
382
|
+
**folder_id** | **String**| The ID of the folder being accessed. |
|
|
383
|
+
**workspace_id** | **String**| Specifies the workspace ID GUID. |
|
|
384
|
+
**count** | **String**| The maximum number of results to be returned by this request. | [optional]
|
|
385
|
+
**dpi** | **String**| Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310. | [optional]
|
|
386
|
+
**max_height** | **String**| Sets the maximum height (in pixels) of the returned image. | [optional]
|
|
387
|
+
**max_width** | **String**| Sets the maximum width (in pixels) of the returned image. | [optional]
|
|
388
|
+
**start_position** | **String**| The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image. | [optional]
|
|
389
|
+
|
|
390
|
+
### Return type
|
|
391
|
+
|
|
392
|
+
[**PageImages**](PageImages.md)
|
|
393
|
+
|
|
394
|
+
### Authorization
|
|
395
|
+
|
|
396
|
+
No authorization required
|
|
397
|
+
|
|
398
|
+
### HTTP request headers
|
|
399
|
+
|
|
400
|
+
- **Content-Type**: Not defined
|
|
401
|
+
- **Accept**: application/json
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
# **list_workspace_folder_items**
|
|
406
|
+
> WorkspaceFolderContents list_workspace_folder_items(account_id, folder_id, workspace_id, opts)
|
|
407
|
+
|
|
408
|
+
List Workspace Folder Contents
|
|
409
|
+
|
|
410
|
+
Retrieves workspace folder contents, which can include sub folders and files.
|
|
411
|
+
|
|
412
|
+
### Example
|
|
413
|
+
```ruby
|
|
414
|
+
# load the gem
|
|
415
|
+
require 'docusign_esign'
|
|
416
|
+
|
|
417
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
418
|
+
|
|
419
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
420
|
+
|
|
421
|
+
folder_id = "folder_id_example" # String | The ID of the folder being accessed.
|
|
422
|
+
|
|
423
|
+
workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
|
|
424
|
+
|
|
425
|
+
opts = {
|
|
426
|
+
count: "count_example", # String | The maximum number of results to be returned by this request.
|
|
427
|
+
include_files: "include_files_example", # String | When set to **true**, file information is returned in the response along with folder information. The default is **false**.
|
|
428
|
+
include_sub_folders: "include_sub_folders_example", # String | When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**.
|
|
429
|
+
include_thumbnails: "include_thumbnails_example", # String | When set to **true**, thumbnails are returned as part of the response. The default is **false**.
|
|
430
|
+
include_user_detail: "include_user_detail_example", # String | Set to **true** to return extended details about the user. The default is **false**.
|
|
431
|
+
start_position: "start_position_example", # String | The position within the total result set from which to start returning values.
|
|
432
|
+
workspace_user_id: "workspace_user_id_example" # String | If set, then the results are filtered to those associated with the specified userId.
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
begin
|
|
436
|
+
#List Workspace Folder Contents
|
|
437
|
+
result = api_instance.list_workspace_folder_items(account_id, folder_id, workspace_id, opts)
|
|
438
|
+
p result
|
|
439
|
+
rescue DocuSign_eSign::ApiError => e
|
|
440
|
+
puts "Exception when calling WorkspacesApi->list_workspace_folder_items: #{e}"
|
|
441
|
+
end
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### Parameters
|
|
445
|
+
|
|
446
|
+
Name | Type | Description | Notes
|
|
447
|
+
------------- | ------------- | ------------- | -------------
|
|
448
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
449
|
+
**folder_id** | **String**| The ID of the folder being accessed. |
|
|
450
|
+
**workspace_id** | **String**| Specifies the workspace ID GUID. |
|
|
451
|
+
**count** | **String**| The maximum number of results to be returned by this request. | [optional]
|
|
452
|
+
**include_files** | **String**| When set to **true**, file information is returned in the response along with folder information. The default is **false**. | [optional]
|
|
453
|
+
**include_sub_folders** | **String**| When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**. | [optional]
|
|
454
|
+
**include_thumbnails** | **String**| When set to **true**, thumbnails are returned as part of the response. The default is **false**. | [optional]
|
|
455
|
+
**include_user_detail** | **String**| Set to **true** to return extended details about the user. The default is **false**. | [optional]
|
|
456
|
+
**start_position** | **String**| The position within the total result set from which to start returning values. | [optional]
|
|
457
|
+
**workspace_user_id** | **String**| If set, then the results are filtered to those associated with the specified userId. | [optional]
|
|
458
|
+
|
|
459
|
+
### Return type
|
|
460
|
+
|
|
461
|
+
[**WorkspaceFolderContents**](WorkspaceFolderContents.md)
|
|
462
|
+
|
|
463
|
+
### Authorization
|
|
464
|
+
|
|
465
|
+
No authorization required
|
|
466
|
+
|
|
467
|
+
### HTTP request headers
|
|
468
|
+
|
|
469
|
+
- **Content-Type**: Not defined
|
|
470
|
+
- **Accept**: application/json
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
# **list_workspaces**
|
|
475
|
+
> WorkspaceList list_workspaces(account_id)
|
|
476
|
+
|
|
477
|
+
List Workspaces
|
|
478
|
+
|
|
479
|
+
Gets information about the Workspaces that have been created.
|
|
480
|
+
|
|
481
|
+
### Example
|
|
482
|
+
```ruby
|
|
483
|
+
# load the gem
|
|
484
|
+
require 'docusign_esign'
|
|
485
|
+
|
|
486
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
487
|
+
|
|
488
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
begin
|
|
492
|
+
#List Workspaces
|
|
493
|
+
result = api_instance.list_workspaces(account_id)
|
|
494
|
+
p result
|
|
495
|
+
rescue DocuSign_eSign::ApiError => e
|
|
496
|
+
puts "Exception when calling WorkspacesApi->list_workspaces: #{e}"
|
|
497
|
+
end
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
### Parameters
|
|
501
|
+
|
|
502
|
+
Name | Type | Description | Notes
|
|
503
|
+
------------- | ------------- | ------------- | -------------
|
|
504
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
505
|
+
|
|
506
|
+
### Return type
|
|
507
|
+
|
|
508
|
+
[**WorkspaceList**](WorkspaceList.md)
|
|
509
|
+
|
|
510
|
+
### Authorization
|
|
511
|
+
|
|
512
|
+
No authorization required
|
|
513
|
+
|
|
514
|
+
### HTTP request headers
|
|
515
|
+
|
|
516
|
+
- **Content-Type**: Not defined
|
|
517
|
+
- **Accept**: application/json
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
# **update_workspace**
|
|
522
|
+
> Workspace update_workspace(account_id, workspace_id, opts)
|
|
523
|
+
|
|
524
|
+
Update Workspace
|
|
525
|
+
|
|
526
|
+
Updates information about a specific workspace.
|
|
527
|
+
|
|
528
|
+
### Example
|
|
529
|
+
```ruby
|
|
530
|
+
# load the gem
|
|
531
|
+
require 'docusign_esign'
|
|
532
|
+
|
|
533
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
534
|
+
|
|
535
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
536
|
+
|
|
537
|
+
workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
|
|
538
|
+
|
|
539
|
+
opts = {
|
|
540
|
+
workspace: DocuSign_eSign::Workspace.new # Workspace |
|
|
541
|
+
}
|
|
542
|
+
|
|
543
|
+
begin
|
|
544
|
+
#Update Workspace
|
|
545
|
+
result = api_instance.update_workspace(account_id, workspace_id, opts)
|
|
546
|
+
p result
|
|
547
|
+
rescue DocuSign_eSign::ApiError => e
|
|
548
|
+
puts "Exception when calling WorkspacesApi->update_workspace: #{e}"
|
|
549
|
+
end
|
|
550
|
+
```
|
|
551
|
+
|
|
552
|
+
### Parameters
|
|
553
|
+
|
|
554
|
+
Name | Type | Description | Notes
|
|
555
|
+
------------- | ------------- | ------------- | -------------
|
|
556
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
557
|
+
**workspace_id** | **String**| Specifies the workspace ID GUID. |
|
|
558
|
+
**workspace** | [**Workspace**](Workspace.md)| | [optional]
|
|
559
|
+
|
|
560
|
+
### Return type
|
|
561
|
+
|
|
562
|
+
[**Workspace**](Workspace.md)
|
|
563
|
+
|
|
564
|
+
### Authorization
|
|
565
|
+
|
|
566
|
+
No authorization required
|
|
567
|
+
|
|
568
|
+
### HTTP request headers
|
|
569
|
+
|
|
570
|
+
- **Content-Type**: Not defined
|
|
571
|
+
- **Accept**: application/json
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
# **update_workspace_file**
|
|
576
|
+
> WorkspaceItem update_workspace_file(account_id, file_id, folder_id, workspace_id)
|
|
577
|
+
|
|
578
|
+
Update Workspace File Metadata
|
|
579
|
+
|
|
580
|
+
Updates workspace item metadata for one or more specific files/folders.
|
|
581
|
+
|
|
582
|
+
### Example
|
|
583
|
+
```ruby
|
|
584
|
+
# load the gem
|
|
585
|
+
require 'docusign_esign'
|
|
586
|
+
|
|
587
|
+
api_instance = DocuSign_eSign::WorkspacesApi.new
|
|
588
|
+
|
|
589
|
+
account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
|
|
590
|
+
|
|
591
|
+
file_id = "file_id_example" # String | Specifies the room file ID GUID.
|
|
592
|
+
|
|
593
|
+
folder_id = "folder_id_example" # String | The ID of the folder being accessed.
|
|
594
|
+
|
|
595
|
+
workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
begin
|
|
599
|
+
#Update Workspace File Metadata
|
|
600
|
+
result = api_instance.update_workspace_file(account_id, file_id, folder_id, workspace_id)
|
|
601
|
+
p result
|
|
602
|
+
rescue DocuSign_eSign::ApiError => e
|
|
603
|
+
puts "Exception when calling WorkspacesApi->update_workspace_file: #{e}"
|
|
604
|
+
end
|
|
605
|
+
```
|
|
606
|
+
|
|
607
|
+
### Parameters
|
|
608
|
+
|
|
609
|
+
Name | Type | Description | Notes
|
|
610
|
+
------------- | ------------- | ------------- | -------------
|
|
611
|
+
**account_id** | **String**| The external account number (int) or account ID Guid. |
|
|
612
|
+
**file_id** | **String**| Specifies the room file ID GUID. |
|
|
613
|
+
**folder_id** | **String**| The ID of the folder being accessed. |
|
|
614
|
+
**workspace_id** | **String**| Specifies the workspace ID GUID. |
|
|
615
|
+
|
|
616
|
+
### Return type
|
|
617
|
+
|
|
618
|
+
[**WorkspaceItem**](WorkspaceItem.md)
|
|
619
|
+
|
|
620
|
+
### Authorization
|
|
621
|
+
|
|
622
|
+
No authorization required
|
|
623
|
+
|
|
624
|
+
### HTTP request headers
|
|
625
|
+
|
|
626
|
+
- **Content-Type**: Not defined
|
|
627
|
+
- **Accept**: application/json
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|