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,342 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign REST API
|
3
|
+
|
4
|
+
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require "uri"
|
13
|
+
|
14
|
+
module DocuSign_eSign
|
15
|
+
|
16
|
+
class ListOptions
|
17
|
+
#
|
18
|
+
attr_accessor :include
|
19
|
+
|
20
|
+
#
|
21
|
+
attr_accessor :include_items
|
22
|
+
|
23
|
+
#
|
24
|
+
attr_accessor :start_position
|
25
|
+
|
26
|
+
# Specifies the items that are returned. Valid values are: * include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.
|
27
|
+
attr_accessor :template
|
28
|
+
|
29
|
+
#
|
30
|
+
attr_accessor :user_filter
|
31
|
+
|
32
|
+
def self.default
|
33
|
+
@@default ||= ListOptions.new
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
class ListItemsOptions
|
38
|
+
# Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
|
39
|
+
attr_accessor :from_date
|
40
|
+
|
41
|
+
#
|
42
|
+
attr_accessor :include_items
|
43
|
+
|
44
|
+
# The email of the folder owner.
|
45
|
+
attr_accessor :owner_email
|
46
|
+
|
47
|
+
# The name of the folder owner.
|
48
|
+
attr_accessor :owner_name
|
49
|
+
|
50
|
+
# The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
|
51
|
+
attr_accessor :search_text
|
52
|
+
|
53
|
+
# The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
|
54
|
+
attr_accessor :start_position
|
55
|
+
|
56
|
+
# The current status of the envelope. If no value is provided, the default search is all/any status.
|
57
|
+
attr_accessor :status
|
58
|
+
|
59
|
+
# Only return items up to this date. If no value is provided, the default search is to the current date.
|
60
|
+
attr_accessor :to_date
|
61
|
+
|
62
|
+
def self.default
|
63
|
+
@@default ||= ListItemsOptions.new
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
class SearchOptions
|
68
|
+
# Specifies that all envelopes that match the criteria are returned.
|
69
|
+
attr_accessor :all
|
70
|
+
|
71
|
+
# Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.
|
72
|
+
attr_accessor :count
|
73
|
+
|
74
|
+
# Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
|
75
|
+
attr_accessor :from_date
|
76
|
+
|
77
|
+
# When set to **true**, the recipient information is returned in the response.
|
78
|
+
attr_accessor :include_recipients
|
79
|
+
|
80
|
+
# Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.
|
81
|
+
attr_accessor :order
|
82
|
+
|
83
|
+
# Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.
|
84
|
+
attr_accessor :order_by
|
85
|
+
|
86
|
+
# Specifies the the starting location in the result set of the items that are returned.
|
87
|
+
attr_accessor :start_position
|
88
|
+
|
89
|
+
# Specifies the end of the date range to return.
|
90
|
+
attr_accessor :to_date
|
91
|
+
|
92
|
+
def self.default
|
93
|
+
@@default ||= SearchOptions.new
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
|
98
|
+
class FoldersApi
|
99
|
+
attr_accessor :api_client
|
100
|
+
|
101
|
+
def initialize(api_client = FoldersApi.default)
|
102
|
+
@api_client = api_client
|
103
|
+
end
|
104
|
+
|
105
|
+
# Gets a list of the folders for the account.
|
106
|
+
# Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.
|
107
|
+
# @param account_id The external account number (int) or account ID Guid.
|
108
|
+
# @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
|
109
|
+
# @return [FoldersResponse]
|
110
|
+
def list(account_id, options = DocuSign_eSign::ListOptions.default)
|
111
|
+
data, _status_code, _headers = list_with_http_info(account_id, options)
|
112
|
+
return data
|
113
|
+
end
|
114
|
+
|
115
|
+
# Gets a list of the folders for the account.
|
116
|
+
# Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.
|
117
|
+
# @param account_id The external account number (int) or account ID Guid.
|
118
|
+
# @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
|
119
|
+
# @return [Array<(FoldersResponse, Fixnum, Hash)>] FoldersResponse data, response status code and response headers
|
120
|
+
def list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default)
|
121
|
+
if @api_client.config.debugging
|
122
|
+
@api_client.config.logger.debug "Calling API: FoldersApi.list ..."
|
123
|
+
end
|
124
|
+
# verify the required parameter 'account_id' is set
|
125
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling FoldersApi.list" if account_id.nil?
|
126
|
+
# resource path
|
127
|
+
local_var_path = "/v2/accounts/{accountId}/folders".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
128
|
+
|
129
|
+
# query parameters
|
130
|
+
query_params = {}
|
131
|
+
query_params[:'include'] = options.include if !options.include.nil?
|
132
|
+
query_params[:'include_items'] = options.include_items if !options.include_items.nil?
|
133
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
134
|
+
query_params[:'template'] = options.template if !options.template.nil?
|
135
|
+
query_params[:'user_filter'] = options.user_filter if !options.user_filter.nil?
|
136
|
+
|
137
|
+
# header parameters
|
138
|
+
header_params = {}
|
139
|
+
# HTTP header 'Accept' (if needed)
|
140
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
141
|
+
|
142
|
+
# form parameters
|
143
|
+
form_params = {}
|
144
|
+
|
145
|
+
# http body (model)
|
146
|
+
post_body = nil
|
147
|
+
auth_names = []
|
148
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
149
|
+
:header_params => header_params,
|
150
|
+
:query_params => query_params,
|
151
|
+
:form_params => form_params,
|
152
|
+
:body => post_body,
|
153
|
+
:auth_names => auth_names,
|
154
|
+
:return_type => 'FoldersResponse')
|
155
|
+
if @api_client.config.debugging
|
156
|
+
@api_client.config.logger.debug "API called: FoldersApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
157
|
+
end
|
158
|
+
return data, status_code, headers
|
159
|
+
end
|
160
|
+
|
161
|
+
# Gets a list of the envelopes in the specified folder.
|
162
|
+
# Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.
|
163
|
+
# @param account_id The external account number (int) or account ID Guid.
|
164
|
+
# @param folder_id The ID of the folder being accessed.
|
165
|
+
# @param DocuSign_eSign::ListItemsOptions Options for modifying the behavior of the function.
|
166
|
+
# @return [FolderItemsResponse]
|
167
|
+
def list_items(account_id, folder_id, options = DocuSign_eSign::ListItemsOptions.default)
|
168
|
+
data, _status_code, _headers = list_items_with_http_info(account_id, folder_id, options)
|
169
|
+
return data
|
170
|
+
end
|
171
|
+
|
172
|
+
# Gets a list of the envelopes in the specified folder.
|
173
|
+
# Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.
|
174
|
+
# @param account_id The external account number (int) or account ID Guid.
|
175
|
+
# @param folder_id The ID of the folder being accessed.
|
176
|
+
# @param DocuSign_eSign::ListItemsOptions Options for modifying the behavior of the function.
|
177
|
+
# @return [Array<(FolderItemsResponse, Fixnum, Hash)>] FolderItemsResponse data, response status code and response headers
|
178
|
+
def list_items_with_http_info(account_id, folder_id, options = DocuSign_eSign::ListItemsOptions.default)
|
179
|
+
if @api_client.config.debugging
|
180
|
+
@api_client.config.logger.debug "Calling API: FoldersApi.list_items ..."
|
181
|
+
end
|
182
|
+
# verify the required parameter 'account_id' is set
|
183
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling FoldersApi.list_items" if account_id.nil?
|
184
|
+
# verify the required parameter 'folder_id' is set
|
185
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling FoldersApi.list_items" if folder_id.nil?
|
186
|
+
# resource path
|
187
|
+
local_var_path = "/v2/accounts/{accountId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s)
|
188
|
+
|
189
|
+
# query parameters
|
190
|
+
query_params = {}
|
191
|
+
query_params[:'from_date'] = options.from_date if !options.from_date.nil?
|
192
|
+
query_params[:'include_items'] = options.include_items if !options.include_items.nil?
|
193
|
+
query_params[:'owner_email'] = options.owner_email if !options.owner_email.nil?
|
194
|
+
query_params[:'owner_name'] = options.owner_name if !options.owner_name.nil?
|
195
|
+
query_params[:'search_text'] = options.search_text if !options.search_text.nil?
|
196
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
197
|
+
query_params[:'status'] = options.status if !options.status.nil?
|
198
|
+
query_params[:'to_date'] = options.to_date if !options.to_date.nil?
|
199
|
+
|
200
|
+
# header parameters
|
201
|
+
header_params = {}
|
202
|
+
# HTTP header 'Accept' (if needed)
|
203
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
204
|
+
|
205
|
+
# form parameters
|
206
|
+
form_params = {}
|
207
|
+
|
208
|
+
# http body (model)
|
209
|
+
post_body = nil
|
210
|
+
auth_names = []
|
211
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
212
|
+
:header_params => header_params,
|
213
|
+
:query_params => query_params,
|
214
|
+
:form_params => form_params,
|
215
|
+
:body => post_body,
|
216
|
+
:auth_names => auth_names,
|
217
|
+
:return_type => 'FolderItemsResponse')
|
218
|
+
if @api_client.config.debugging
|
219
|
+
@api_client.config.logger.debug "API called: FoldersApi#list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
220
|
+
end
|
221
|
+
return data, status_code, headers
|
222
|
+
end
|
223
|
+
|
224
|
+
# Moves an envelope from its current folder to the specified folder.
|
225
|
+
# Moves envelopes to the specified folder.
|
226
|
+
# @param account_id The external account number (int) or account ID Guid.
|
227
|
+
# @param folder_id The ID of the folder being accessed.
|
228
|
+
# @param folders_request (optional parameter)
|
229
|
+
# @return [FoldersResponse]
|
230
|
+
def move_envelopes(account_id, folder_id, folders_request)
|
231
|
+
data, _status_code, _headers = move_envelopes_with_http_info(account_id, folder_id, folders_request)
|
232
|
+
return data
|
233
|
+
end
|
234
|
+
|
235
|
+
# Moves an envelope from its current folder to the specified folder.
|
236
|
+
# Moves envelopes to the specified folder.
|
237
|
+
# @param account_id The external account number (int) or account ID Guid.
|
238
|
+
# @param folder_id The ID of the folder being accessed.
|
239
|
+
# @param folders_request (optional parameter)
|
240
|
+
# @return [Array<(FoldersResponse, Fixnum, Hash)>] FoldersResponse data, response status code and response headers
|
241
|
+
def move_envelopes_with_http_info(account_id, folder_id, folders_request)
|
242
|
+
if @api_client.config.debugging
|
243
|
+
@api_client.config.logger.debug "Calling API: FoldersApi.move_envelopes ..."
|
244
|
+
end
|
245
|
+
# verify the required parameter 'account_id' is set
|
246
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling FoldersApi.move_envelopes" if account_id.nil?
|
247
|
+
# verify the required parameter 'folder_id' is set
|
248
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling FoldersApi.move_envelopes" if folder_id.nil?
|
249
|
+
# resource path
|
250
|
+
local_var_path = "/v2/accounts/{accountId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s)
|
251
|
+
|
252
|
+
# query parameters
|
253
|
+
query_params = {}
|
254
|
+
|
255
|
+
# header parameters
|
256
|
+
header_params = {}
|
257
|
+
# HTTP header 'Accept' (if needed)
|
258
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
259
|
+
|
260
|
+
# form parameters
|
261
|
+
form_params = {}
|
262
|
+
|
263
|
+
# http body (model)
|
264
|
+
post_body = @api_client.object_to_http_body(folders_request)
|
265
|
+
auth_names = []
|
266
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
267
|
+
:header_params => header_params,
|
268
|
+
:query_params => query_params,
|
269
|
+
:form_params => form_params,
|
270
|
+
:body => post_body,
|
271
|
+
:auth_names => auth_names,
|
272
|
+
:return_type => 'FoldersResponse')
|
273
|
+
if @api_client.config.debugging
|
274
|
+
@api_client.config.logger.debug "API called: FoldersApi#move_envelopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
275
|
+
end
|
276
|
+
return data, status_code, headers
|
277
|
+
end
|
278
|
+
|
279
|
+
# Gets a list of envelopes in folders matching the specified criteria.
|
280
|
+
# Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.
|
281
|
+
# @param account_id The external account number (int) or account ID Guid.
|
282
|
+
# @param search_folder_id Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
|
283
|
+
# @param DocuSign_eSign::SearchOptions Options for modifying the behavior of the function.
|
284
|
+
# @return [FolderItemResponse]
|
285
|
+
def search(account_id, search_folder_id, options = DocuSign_eSign::SearchOptions.default)
|
286
|
+
data, _status_code, _headers = search_with_http_info(account_id, search_folder_id, options)
|
287
|
+
return data
|
288
|
+
end
|
289
|
+
|
290
|
+
# Gets a list of envelopes in folders matching the specified criteria.
|
291
|
+
# Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.
|
292
|
+
# @param account_id The external account number (int) or account ID Guid.
|
293
|
+
# @param search_folder_id Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
|
294
|
+
# @param DocuSign_eSign::SearchOptions Options for modifying the behavior of the function.
|
295
|
+
# @return [Array<(FolderItemResponse, Fixnum, Hash)>] FolderItemResponse data, response status code and response headers
|
296
|
+
def search_with_http_info(account_id, search_folder_id, options = DocuSign_eSign::SearchOptions.default)
|
297
|
+
if @api_client.config.debugging
|
298
|
+
@api_client.config.logger.debug "Calling API: FoldersApi.search ..."
|
299
|
+
end
|
300
|
+
# verify the required parameter 'account_id' is set
|
301
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling FoldersApi.search" if account_id.nil?
|
302
|
+
# verify the required parameter 'search_folder_id' is set
|
303
|
+
fail ArgumentError, "Missing the required parameter 'search_folder_id' when calling FoldersApi.search" if search_folder_id.nil?
|
304
|
+
# resource path
|
305
|
+
local_var_path = "/v2/accounts/{accountId}/search_folders/{searchFolderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'searchFolderId' + '}', search_folder_id.to_s)
|
306
|
+
|
307
|
+
# query parameters
|
308
|
+
query_params = {}
|
309
|
+
query_params[:'all'] = options.all if !options.all.nil?
|
310
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
311
|
+
query_params[:'from_date'] = options.from_date if !options.from_date.nil?
|
312
|
+
query_params[:'include_recipients'] = options.include_recipients if !options.include_recipients.nil?
|
313
|
+
query_params[:'order'] = options.order if !options.order.nil?
|
314
|
+
query_params[:'order_by'] = options.order_by if !options.order_by.nil?
|
315
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
316
|
+
query_params[:'to_date'] = options.to_date if !options.to_date.nil?
|
317
|
+
|
318
|
+
# header parameters
|
319
|
+
header_params = {}
|
320
|
+
# HTTP header 'Accept' (if needed)
|
321
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
322
|
+
|
323
|
+
# form parameters
|
324
|
+
form_params = {}
|
325
|
+
|
326
|
+
# http body (model)
|
327
|
+
post_body = nil
|
328
|
+
auth_names = []
|
329
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
330
|
+
:header_params => header_params,
|
331
|
+
:query_params => query_params,
|
332
|
+
:form_params => form_params,
|
333
|
+
:body => post_body,
|
334
|
+
:auth_names => auth_names,
|
335
|
+
:return_type => 'FolderItemResponse')
|
336
|
+
if @api_client.config.debugging
|
337
|
+
@api_client.config.logger.debug "API called: FoldersApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
338
|
+
end
|
339
|
+
return data, status_code, headers
|
340
|
+
end
|
341
|
+
end
|
342
|
+
end
|
@@ -0,0 +1,596 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign REST API
|
3
|
+
|
4
|
+
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require "uri"
|
13
|
+
|
14
|
+
module DocuSign_eSign
|
15
|
+
|
16
|
+
class ListGroupUsersOptions
|
17
|
+
# Number of records to return. The number must be greater than 1 and less than or equal to 100.
|
18
|
+
attr_accessor :count
|
19
|
+
|
20
|
+
# Starting value for the list.
|
21
|
+
attr_accessor :start_position
|
22
|
+
|
23
|
+
def self.default
|
24
|
+
@@default ||= ListGroupUsersOptions.new
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
class ListGroupsOptions
|
29
|
+
# Number of records to return. The number must be greater than 1 and less than or equal to 100.
|
30
|
+
attr_accessor :count
|
31
|
+
|
32
|
+
# Filters the groups returned by the group name or a sub-string of group name.
|
33
|
+
attr_accessor :group_name
|
34
|
+
|
35
|
+
#
|
36
|
+
attr_accessor :group_type
|
37
|
+
|
38
|
+
#
|
39
|
+
attr_accessor :search_text
|
40
|
+
|
41
|
+
# Starting value for the list.
|
42
|
+
attr_accessor :start_position
|
43
|
+
|
44
|
+
def self.default
|
45
|
+
@@default ||= ListGroupsOptions.new
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
|
50
|
+
class GroupsApi
|
51
|
+
attr_accessor :api_client
|
52
|
+
|
53
|
+
def initialize(api_client = GroupsApi.default)
|
54
|
+
@api_client = api_client
|
55
|
+
end
|
56
|
+
|
57
|
+
# Creates one or more groups for the account.
|
58
|
+
# Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.
|
59
|
+
# @param account_id The external account number (int) or account ID Guid.
|
60
|
+
# @param group_information (optional parameter)
|
61
|
+
# @return [GroupInformation]
|
62
|
+
def create_groups(account_id, group_information)
|
63
|
+
data, _status_code, _headers = create_groups_with_http_info(account_id, group_information)
|
64
|
+
return data
|
65
|
+
end
|
66
|
+
|
67
|
+
# Creates one or more groups for the account.
|
68
|
+
# Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.
|
69
|
+
# @param account_id The external account number (int) or account ID Guid.
|
70
|
+
# @param group_information (optional parameter)
|
71
|
+
# @return [Array<(GroupInformation, Fixnum, Hash)>] GroupInformation data, response status code and response headers
|
72
|
+
def create_groups_with_http_info(account_id, group_information)
|
73
|
+
if @api_client.config.debugging
|
74
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.create_groups ..."
|
75
|
+
end
|
76
|
+
# verify the required parameter 'account_id' is set
|
77
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.create_groups" if account_id.nil?
|
78
|
+
# resource path
|
79
|
+
local_var_path = "/v2/accounts/{accountId}/groups".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
80
|
+
|
81
|
+
# query parameters
|
82
|
+
query_params = {}
|
83
|
+
|
84
|
+
# header parameters
|
85
|
+
header_params = {}
|
86
|
+
# HTTP header 'Accept' (if needed)
|
87
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
88
|
+
|
89
|
+
# form parameters
|
90
|
+
form_params = {}
|
91
|
+
|
92
|
+
# http body (model)
|
93
|
+
post_body = @api_client.object_to_http_body(group_information)
|
94
|
+
auth_names = []
|
95
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
96
|
+
:header_params => header_params,
|
97
|
+
:query_params => query_params,
|
98
|
+
:form_params => form_params,
|
99
|
+
:body => post_body,
|
100
|
+
:auth_names => auth_names,
|
101
|
+
:return_type => 'GroupInformation')
|
102
|
+
if @api_client.config.debugging
|
103
|
+
@api_client.config.logger.debug "API called: GroupsApi#create_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
104
|
+
end
|
105
|
+
return data, status_code, headers
|
106
|
+
end
|
107
|
+
|
108
|
+
# Deletes brand information from the requested group.
|
109
|
+
# Deletes brand information from the requested group.
|
110
|
+
# @param account_id The external account number (int) or account ID Guid.
|
111
|
+
# @param group_id The ID of the group being accessed.
|
112
|
+
# @param brands_request (optional parameter)
|
113
|
+
# @return [BrandsResponse]
|
114
|
+
def delete_brands(account_id, group_id, brands_request)
|
115
|
+
data, _status_code, _headers = delete_brands_with_http_info(account_id, group_id, brands_request)
|
116
|
+
return data
|
117
|
+
end
|
118
|
+
|
119
|
+
# Deletes brand information from the requested group.
|
120
|
+
# Deletes brand information from the requested group.
|
121
|
+
# @param account_id The external account number (int) or account ID Guid.
|
122
|
+
# @param group_id The ID of the group being accessed.
|
123
|
+
# @param brands_request (optional parameter)
|
124
|
+
# @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
|
125
|
+
def delete_brands_with_http_info(account_id, group_id, brands_request)
|
126
|
+
if @api_client.config.debugging
|
127
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.delete_brands ..."
|
128
|
+
end
|
129
|
+
# verify the required parameter 'account_id' is set
|
130
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.delete_brands" if account_id.nil?
|
131
|
+
# verify the required parameter 'group_id' is set
|
132
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.delete_brands" if group_id.nil?
|
133
|
+
# resource path
|
134
|
+
local_var_path = "/v2/accounts/{accountId}/groups/{groupId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'groupId' + '}', group_id.to_s)
|
135
|
+
|
136
|
+
# query parameters
|
137
|
+
query_params = {}
|
138
|
+
|
139
|
+
# header parameters
|
140
|
+
header_params = {}
|
141
|
+
# HTTP header 'Accept' (if needed)
|
142
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
143
|
+
|
144
|
+
# form parameters
|
145
|
+
form_params = {}
|
146
|
+
|
147
|
+
# http body (model)
|
148
|
+
post_body = @api_client.object_to_http_body(brands_request)
|
149
|
+
auth_names = []
|
150
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
151
|
+
:header_params => header_params,
|
152
|
+
:query_params => query_params,
|
153
|
+
:form_params => form_params,
|
154
|
+
:body => post_body,
|
155
|
+
:auth_names => auth_names,
|
156
|
+
:return_type => 'BrandsResponse')
|
157
|
+
if @api_client.config.debugging
|
158
|
+
@api_client.config.logger.debug "API called: GroupsApi#delete_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
159
|
+
end
|
160
|
+
return data, status_code, headers
|
161
|
+
end
|
162
|
+
|
163
|
+
# Deletes one or more users from a gro
|
164
|
+
# Deletes one or more users from a group.
|
165
|
+
# @param account_id The external account number (int) or account ID Guid.
|
166
|
+
# @param group_id The ID of the group being accessed.
|
167
|
+
# @param user_info_list (optional parameter)
|
168
|
+
# @return [UsersResponse]
|
169
|
+
def delete_group_users(account_id, group_id, user_info_list)
|
170
|
+
data, _status_code, _headers = delete_group_users_with_http_info(account_id, group_id, user_info_list)
|
171
|
+
return data
|
172
|
+
end
|
173
|
+
|
174
|
+
# Deletes one or more users from a gro
|
175
|
+
# Deletes one or more users from a group.
|
176
|
+
# @param account_id The external account number (int) or account ID Guid.
|
177
|
+
# @param group_id The ID of the group being accessed.
|
178
|
+
# @param user_info_list (optional parameter)
|
179
|
+
# @return [Array<(UsersResponse, Fixnum, Hash)>] UsersResponse data, response status code and response headers
|
180
|
+
def delete_group_users_with_http_info(account_id, group_id, user_info_list)
|
181
|
+
if @api_client.config.debugging
|
182
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.delete_group_users ..."
|
183
|
+
end
|
184
|
+
# verify the required parameter 'account_id' is set
|
185
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.delete_group_users" if account_id.nil?
|
186
|
+
# verify the required parameter 'group_id' is set
|
187
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.delete_group_users" if group_id.nil?
|
188
|
+
# resource path
|
189
|
+
local_var_path = "/v2/accounts/{accountId}/groups/{groupId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'groupId' + '}', group_id.to_s)
|
190
|
+
|
191
|
+
# query parameters
|
192
|
+
query_params = {}
|
193
|
+
|
194
|
+
# header parameters
|
195
|
+
header_params = {}
|
196
|
+
# HTTP header 'Accept' (if needed)
|
197
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
198
|
+
|
199
|
+
# form parameters
|
200
|
+
form_params = {}
|
201
|
+
|
202
|
+
# http body (model)
|
203
|
+
post_body = @api_client.object_to_http_body(user_info_list)
|
204
|
+
auth_names = []
|
205
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
206
|
+
:header_params => header_params,
|
207
|
+
:query_params => query_params,
|
208
|
+
:form_params => form_params,
|
209
|
+
:body => post_body,
|
210
|
+
:auth_names => auth_names,
|
211
|
+
:return_type => 'UsersResponse')
|
212
|
+
if @api_client.config.debugging
|
213
|
+
@api_client.config.logger.debug "API called: GroupsApi#delete_group_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
214
|
+
end
|
215
|
+
return data, status_code, headers
|
216
|
+
end
|
217
|
+
|
218
|
+
# Deletes an existing user group.
|
219
|
+
# Deletes an existing user group.
|
220
|
+
# @param account_id The external account number (int) or account ID Guid.
|
221
|
+
# @param group_information (optional parameter)
|
222
|
+
# @return [GroupInformation]
|
223
|
+
def delete_groups(account_id, group_information)
|
224
|
+
data, _status_code, _headers = delete_groups_with_http_info(account_id, group_information)
|
225
|
+
return data
|
226
|
+
end
|
227
|
+
|
228
|
+
# Deletes an existing user group.
|
229
|
+
# Deletes an existing user group.
|
230
|
+
# @param account_id The external account number (int) or account ID Guid.
|
231
|
+
# @param group_information (optional parameter)
|
232
|
+
# @return [Array<(GroupInformation, Fixnum, Hash)>] GroupInformation data, response status code and response headers
|
233
|
+
def delete_groups_with_http_info(account_id, group_information)
|
234
|
+
if @api_client.config.debugging
|
235
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.delete_groups ..."
|
236
|
+
end
|
237
|
+
# verify the required parameter 'account_id' is set
|
238
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.delete_groups" if account_id.nil?
|
239
|
+
# resource path
|
240
|
+
local_var_path = "/v2/accounts/{accountId}/groups".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
241
|
+
|
242
|
+
# query parameters
|
243
|
+
query_params = {}
|
244
|
+
|
245
|
+
# header parameters
|
246
|
+
header_params = {}
|
247
|
+
# HTTP header 'Accept' (if needed)
|
248
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
249
|
+
|
250
|
+
# form parameters
|
251
|
+
form_params = {}
|
252
|
+
|
253
|
+
# http body (model)
|
254
|
+
post_body = @api_client.object_to_http_body(group_information)
|
255
|
+
auth_names = []
|
256
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
257
|
+
:header_params => header_params,
|
258
|
+
:query_params => query_params,
|
259
|
+
:form_params => form_params,
|
260
|
+
:body => post_body,
|
261
|
+
:auth_names => auth_names,
|
262
|
+
:return_type => 'GroupInformation')
|
263
|
+
if @api_client.config.debugging
|
264
|
+
@api_client.config.logger.debug "API called: GroupsApi#delete_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
265
|
+
end
|
266
|
+
return data, status_code, headers
|
267
|
+
end
|
268
|
+
|
269
|
+
# Gets group brand ID Information.
|
270
|
+
# Retrieves information about the brands associated with the requested group.
|
271
|
+
# @param account_id The external account number (int) or account ID Guid.
|
272
|
+
# @param group_id The ID of the group being accessed.
|
273
|
+
# @return [BrandsResponse]
|
274
|
+
def get_brands(account_id, group_id)
|
275
|
+
data, _status_code, _headers = get_brands_with_http_info(account_id, group_id)
|
276
|
+
return data
|
277
|
+
end
|
278
|
+
|
279
|
+
# Gets group brand ID Information.
|
280
|
+
# Retrieves information about the brands associated with the requested group.
|
281
|
+
# @param account_id The external account number (int) or account ID Guid.
|
282
|
+
# @param group_id The ID of the group being accessed.
|
283
|
+
# @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
|
284
|
+
def get_brands_with_http_info(account_id, group_id)
|
285
|
+
if @api_client.config.debugging
|
286
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.get_brands ..."
|
287
|
+
end
|
288
|
+
# verify the required parameter 'account_id' is set
|
289
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.get_brands" if account_id.nil?
|
290
|
+
# verify the required parameter 'group_id' is set
|
291
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_brands" if group_id.nil?
|
292
|
+
# resource path
|
293
|
+
local_var_path = "/v2/accounts/{accountId}/groups/{groupId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'groupId' + '}', group_id.to_s)
|
294
|
+
|
295
|
+
# query parameters
|
296
|
+
query_params = {}
|
297
|
+
|
298
|
+
# header parameters
|
299
|
+
header_params = {}
|
300
|
+
# HTTP header 'Accept' (if needed)
|
301
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
302
|
+
|
303
|
+
# form parameters
|
304
|
+
form_params = {}
|
305
|
+
|
306
|
+
# http body (model)
|
307
|
+
post_body = nil
|
308
|
+
auth_names = []
|
309
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
310
|
+
:header_params => header_params,
|
311
|
+
:query_params => query_params,
|
312
|
+
:form_params => form_params,
|
313
|
+
:body => post_body,
|
314
|
+
:auth_names => auth_names,
|
315
|
+
:return_type => 'BrandsResponse')
|
316
|
+
if @api_client.config.debugging
|
317
|
+
@api_client.config.logger.debug "API called: GroupsApi#get_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
318
|
+
end
|
319
|
+
return data, status_code, headers
|
320
|
+
end
|
321
|
+
|
322
|
+
# Gets a list of users in a group.
|
323
|
+
# Retrieves a list of users in a group.
|
324
|
+
# @param account_id The external account number (int) or account ID Guid.
|
325
|
+
# @param group_id The ID of the group being accessed.
|
326
|
+
# @param DocuSign_eSign::ListGroupUsersOptions Options for modifying the behavior of the function.
|
327
|
+
# @return [UsersResponse]
|
328
|
+
def list_group_users(account_id, group_id, options = DocuSign_eSign::ListGroupUsersOptions.default)
|
329
|
+
data, _status_code, _headers = list_group_users_with_http_info(account_id, group_id, options)
|
330
|
+
return data
|
331
|
+
end
|
332
|
+
|
333
|
+
# Gets a list of users in a group.
|
334
|
+
# Retrieves a list of users in a group.
|
335
|
+
# @param account_id The external account number (int) or account ID Guid.
|
336
|
+
# @param group_id The ID of the group being accessed.
|
337
|
+
# @param DocuSign_eSign::ListGroupUsersOptions Options for modifying the behavior of the function.
|
338
|
+
# @return [Array<(UsersResponse, Fixnum, Hash)>] UsersResponse data, response status code and response headers
|
339
|
+
def list_group_users_with_http_info(account_id, group_id, options = DocuSign_eSign::ListGroupUsersOptions.default)
|
340
|
+
if @api_client.config.debugging
|
341
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.list_group_users ..."
|
342
|
+
end
|
343
|
+
# verify the required parameter 'account_id' is set
|
344
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.list_group_users" if account_id.nil?
|
345
|
+
# verify the required parameter 'group_id' is set
|
346
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.list_group_users" if group_id.nil?
|
347
|
+
# resource path
|
348
|
+
local_var_path = "/v2/accounts/{accountId}/groups/{groupId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'groupId' + '}', group_id.to_s)
|
349
|
+
|
350
|
+
# query parameters
|
351
|
+
query_params = {}
|
352
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
353
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
354
|
+
|
355
|
+
# header parameters
|
356
|
+
header_params = {}
|
357
|
+
# HTTP header 'Accept' (if needed)
|
358
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
359
|
+
|
360
|
+
# form parameters
|
361
|
+
form_params = {}
|
362
|
+
|
363
|
+
# http body (model)
|
364
|
+
post_body = nil
|
365
|
+
auth_names = []
|
366
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
367
|
+
:header_params => header_params,
|
368
|
+
:query_params => query_params,
|
369
|
+
:form_params => form_params,
|
370
|
+
:body => post_body,
|
371
|
+
:auth_names => auth_names,
|
372
|
+
:return_type => 'UsersResponse')
|
373
|
+
if @api_client.config.debugging
|
374
|
+
@api_client.config.logger.debug "API called: GroupsApi#list_group_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
375
|
+
end
|
376
|
+
return data, status_code, headers
|
377
|
+
end
|
378
|
+
|
379
|
+
# Gets information about groups associated with the account.
|
380
|
+
# Retrieves information about groups associated with the account.
|
381
|
+
# @param account_id The external account number (int) or account ID Guid.
|
382
|
+
# @param DocuSign_eSign::ListGroupsOptions Options for modifying the behavior of the function.
|
383
|
+
# @return [GroupInformation]
|
384
|
+
def list_groups(account_id, options = DocuSign_eSign::ListGroupsOptions.default)
|
385
|
+
data, _status_code, _headers = list_groups_with_http_info(account_id, options)
|
386
|
+
return data
|
387
|
+
end
|
388
|
+
|
389
|
+
# Gets information about groups associated with the account.
|
390
|
+
# Retrieves information about groups associated with the account.
|
391
|
+
# @param account_id The external account number (int) or account ID Guid.
|
392
|
+
# @param DocuSign_eSign::ListGroupsOptions Options for modifying the behavior of the function.
|
393
|
+
# @return [Array<(GroupInformation, Fixnum, Hash)>] GroupInformation data, response status code and response headers
|
394
|
+
def list_groups_with_http_info(account_id, options = DocuSign_eSign::ListGroupsOptions.default)
|
395
|
+
if @api_client.config.debugging
|
396
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.list_groups ..."
|
397
|
+
end
|
398
|
+
# verify the required parameter 'account_id' is set
|
399
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.list_groups" if account_id.nil?
|
400
|
+
# resource path
|
401
|
+
local_var_path = "/v2/accounts/{accountId}/groups".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
402
|
+
|
403
|
+
# query parameters
|
404
|
+
query_params = {}
|
405
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
406
|
+
query_params[:'group_name'] = options.group_name if !options.group_name.nil?
|
407
|
+
query_params[:'group_type'] = options.group_type if !options.group_type.nil?
|
408
|
+
query_params[:'search_text'] = options.search_text if !options.search_text.nil?
|
409
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
410
|
+
|
411
|
+
# header parameters
|
412
|
+
header_params = {}
|
413
|
+
# HTTP header 'Accept' (if needed)
|
414
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
415
|
+
|
416
|
+
# form parameters
|
417
|
+
form_params = {}
|
418
|
+
|
419
|
+
# http body (model)
|
420
|
+
post_body = nil
|
421
|
+
auth_names = []
|
422
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
423
|
+
:header_params => header_params,
|
424
|
+
:query_params => query_params,
|
425
|
+
:form_params => form_params,
|
426
|
+
:body => post_body,
|
427
|
+
:auth_names => auth_names,
|
428
|
+
:return_type => 'GroupInformation')
|
429
|
+
if @api_client.config.debugging
|
430
|
+
@api_client.config.logger.debug "API called: GroupsApi#list_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
431
|
+
end
|
432
|
+
return data, status_code, headers
|
433
|
+
end
|
434
|
+
|
435
|
+
# Adds group brand ID information to a group.
|
436
|
+
# Adds group brand ID information to a group.
|
437
|
+
# @param account_id The external account number (int) or account ID Guid.
|
438
|
+
# @param group_id The ID of the group being accessed.
|
439
|
+
# @param brands_request (optional parameter)
|
440
|
+
# @return [BrandsResponse]
|
441
|
+
def update_brands(account_id, group_id, brands_request)
|
442
|
+
data, _status_code, _headers = update_brands_with_http_info(account_id, group_id, brands_request)
|
443
|
+
return data
|
444
|
+
end
|
445
|
+
|
446
|
+
# Adds group brand ID information to a group.
|
447
|
+
# Adds group brand ID information to a group.
|
448
|
+
# @param account_id The external account number (int) or account ID Guid.
|
449
|
+
# @param group_id The ID of the group being accessed.
|
450
|
+
# @param brands_request (optional parameter)
|
451
|
+
# @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
|
452
|
+
def update_brands_with_http_info(account_id, group_id, brands_request)
|
453
|
+
if @api_client.config.debugging
|
454
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.update_brands ..."
|
455
|
+
end
|
456
|
+
# verify the required parameter 'account_id' is set
|
457
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.update_brands" if account_id.nil?
|
458
|
+
# verify the required parameter 'group_id' is set
|
459
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.update_brands" if group_id.nil?
|
460
|
+
# resource path
|
461
|
+
local_var_path = "/v2/accounts/{accountId}/groups/{groupId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'groupId' + '}', group_id.to_s)
|
462
|
+
|
463
|
+
# query parameters
|
464
|
+
query_params = {}
|
465
|
+
|
466
|
+
# header parameters
|
467
|
+
header_params = {}
|
468
|
+
# HTTP header 'Accept' (if needed)
|
469
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
470
|
+
|
471
|
+
# form parameters
|
472
|
+
form_params = {}
|
473
|
+
|
474
|
+
# http body (model)
|
475
|
+
post_body = @api_client.object_to_http_body(brands_request)
|
476
|
+
auth_names = []
|
477
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
478
|
+
:header_params => header_params,
|
479
|
+
:query_params => query_params,
|
480
|
+
:form_params => form_params,
|
481
|
+
:body => post_body,
|
482
|
+
:auth_names => auth_names,
|
483
|
+
:return_type => 'BrandsResponse')
|
484
|
+
if @api_client.config.debugging
|
485
|
+
@api_client.config.logger.debug "API called: GroupsApi#update_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
486
|
+
end
|
487
|
+
return data, status_code, headers
|
488
|
+
end
|
489
|
+
|
490
|
+
# Adds one or more users to an existing group.
|
491
|
+
# Adds one or more users to an existing group.
|
492
|
+
# @param account_id The external account number (int) or account ID Guid.
|
493
|
+
# @param group_id The ID of the group being accessed.
|
494
|
+
# @param user_info_list (optional parameter)
|
495
|
+
# @return [UsersResponse]
|
496
|
+
def update_group_users(account_id, group_id, user_info_list)
|
497
|
+
data, _status_code, _headers = update_group_users_with_http_info(account_id, group_id, user_info_list)
|
498
|
+
return data
|
499
|
+
end
|
500
|
+
|
501
|
+
# Adds one or more users to an existing group.
|
502
|
+
# Adds one or more users to an existing group.
|
503
|
+
# @param account_id The external account number (int) or account ID Guid.
|
504
|
+
# @param group_id The ID of the group being accessed.
|
505
|
+
# @param user_info_list (optional parameter)
|
506
|
+
# @return [Array<(UsersResponse, Fixnum, Hash)>] UsersResponse data, response status code and response headers
|
507
|
+
def update_group_users_with_http_info(account_id, group_id, user_info_list)
|
508
|
+
if @api_client.config.debugging
|
509
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.update_group_users ..."
|
510
|
+
end
|
511
|
+
# verify the required parameter 'account_id' is set
|
512
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.update_group_users" if account_id.nil?
|
513
|
+
# verify the required parameter 'group_id' is set
|
514
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.update_group_users" if group_id.nil?
|
515
|
+
# resource path
|
516
|
+
local_var_path = "/v2/accounts/{accountId}/groups/{groupId}/users".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'groupId' + '}', group_id.to_s)
|
517
|
+
|
518
|
+
# query parameters
|
519
|
+
query_params = {}
|
520
|
+
|
521
|
+
# header parameters
|
522
|
+
header_params = {}
|
523
|
+
# HTTP header 'Accept' (if needed)
|
524
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
525
|
+
|
526
|
+
# form parameters
|
527
|
+
form_params = {}
|
528
|
+
|
529
|
+
# http body (model)
|
530
|
+
post_body = @api_client.object_to_http_body(user_info_list)
|
531
|
+
auth_names = []
|
532
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
533
|
+
:header_params => header_params,
|
534
|
+
:query_params => query_params,
|
535
|
+
:form_params => form_params,
|
536
|
+
:body => post_body,
|
537
|
+
:auth_names => auth_names,
|
538
|
+
:return_type => 'UsersResponse')
|
539
|
+
if @api_client.config.debugging
|
540
|
+
@api_client.config.logger.debug "API called: GroupsApi#update_group_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
541
|
+
end
|
542
|
+
return data, status_code, headers
|
543
|
+
end
|
544
|
+
|
545
|
+
# Updates the group information for a group.
|
546
|
+
# Updates the group name and modifies, or sets, the permission profile for the group.
|
547
|
+
# @param account_id The external account number (int) or account ID Guid.
|
548
|
+
# @param group_information (optional parameter)
|
549
|
+
# @return [GroupInformation]
|
550
|
+
def update_groups(account_id, group_information)
|
551
|
+
data, _status_code, _headers = update_groups_with_http_info(account_id, group_information)
|
552
|
+
return data
|
553
|
+
end
|
554
|
+
|
555
|
+
# Updates the group information for a group.
|
556
|
+
# Updates the group name and modifies, or sets, the permission profile for the group.
|
557
|
+
# @param account_id The external account number (int) or account ID Guid.
|
558
|
+
# @param group_information (optional parameter)
|
559
|
+
# @return [Array<(GroupInformation, Fixnum, Hash)>] GroupInformation data, response status code and response headers
|
560
|
+
def update_groups_with_http_info(account_id, group_information)
|
561
|
+
if @api_client.config.debugging
|
562
|
+
@api_client.config.logger.debug "Calling API: GroupsApi.update_groups ..."
|
563
|
+
end
|
564
|
+
# verify the required parameter 'account_id' is set
|
565
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling GroupsApi.update_groups" if account_id.nil?
|
566
|
+
# resource path
|
567
|
+
local_var_path = "/v2/accounts/{accountId}/groups".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
568
|
+
|
569
|
+
# query parameters
|
570
|
+
query_params = {}
|
571
|
+
|
572
|
+
# header parameters
|
573
|
+
header_params = {}
|
574
|
+
# HTTP header 'Accept' (if needed)
|
575
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
576
|
+
|
577
|
+
# form parameters
|
578
|
+
form_params = {}
|
579
|
+
|
580
|
+
# http body (model)
|
581
|
+
post_body = @api_client.object_to_http_body(group_information)
|
582
|
+
auth_names = []
|
583
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
584
|
+
:header_params => header_params,
|
585
|
+
:query_params => query_params,
|
586
|
+
:form_params => form_params,
|
587
|
+
:body => post_body,
|
588
|
+
:auth_names => auth_names,
|
589
|
+
:return_type => 'GroupInformation')
|
590
|
+
if @api_client.config.debugging
|
591
|
+
@api_client.config.logger.debug "API called: GroupsApi#update_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
592
|
+
end
|
593
|
+
return data, status_code, headers
|
594
|
+
end
|
595
|
+
end
|
596
|
+
end
|