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
data/docs/Zip.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# DocuSign_eSign::Zip
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**anchor_case_sensitive** | **String** | When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. | [optional]
|
|
7
|
+
**anchor_horizontal_alignment** | **String** | Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. | [optional]
|
|
8
|
+
**anchor_ignore_if_not_present** | **String** | When set to **true**, this tab is ignored if anchorString is not found in the document. | [optional]
|
|
9
|
+
**anchor_match_whole_word** | **String** | When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. | [optional]
|
|
10
|
+
**anchor_string** | **String** | Anchor text information for a radio button. | [optional]
|
|
11
|
+
**anchor_units** | **String** | Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. | [optional]
|
|
12
|
+
**anchor_x_offset** | **String** | Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
|
|
13
|
+
**anchor_y_offset** | **String** | Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
|
|
14
|
+
**bold** | **String** | When set to **true**, the information in the tab is bold. | [optional]
|
|
15
|
+
**conceal_value_on_document** | **String** | When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. | [optional]
|
|
16
|
+
**conditional_parent_label** | **String** | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | [optional]
|
|
17
|
+
**conditional_parent_value** | **String** | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. | [optional]
|
|
18
|
+
**custom_tab_id** | **String** | The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. | [optional]
|
|
19
|
+
**disable_auto_size** | **String** | When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. | [optional]
|
|
20
|
+
**document_id** | **String** | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. | [optional]
|
|
21
|
+
**error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
|
|
22
|
+
**font** | **String** | The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. | [optional]
|
|
23
|
+
**font_color** | **String** | The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. | [optional]
|
|
24
|
+
**font_size** | **String** | The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. | [optional]
|
|
25
|
+
**italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
|
|
26
|
+
**locked** | **String** | When set to **true**, the signer cannot change the data of the custom tab. | [optional]
|
|
27
|
+
**max_length** | **Integer** | An optional value that describes the maximum length of the property when the property is a string. | [optional]
|
|
28
|
+
**merge_field** | [**MergeField**](MergeField.md) | | [optional]
|
|
29
|
+
**name** | **String** | | [optional]
|
|
30
|
+
**original_value** | **String** | The initial value of the tab when it was sent to the recipient. | [optional]
|
|
31
|
+
**page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
|
|
32
|
+
**recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
|
|
33
|
+
**require_all** | **String** | When set to **true** and shared is true, information must be entered in this field to complete the envelope. | [optional]
|
|
34
|
+
**required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
|
|
35
|
+
**require_initial_on_shared_change** | **String** | Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. | [optional]
|
|
36
|
+
**sender_required** | **String** | When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. | [optional]
|
|
37
|
+
**shared** | **String** | When set to **true**, this custom tab is shared. | [optional]
|
|
38
|
+
**status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
|
|
39
|
+
**tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
|
|
40
|
+
**tab_label** | **String** | The label string associated with the tab. | [optional]
|
|
41
|
+
**tab_order** | **String** | | [optional]
|
|
42
|
+
**template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
|
|
43
|
+
**template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
|
|
44
|
+
**underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
|
|
45
|
+
**use_dash4** | **String** | | [optional]
|
|
46
|
+
**validation_message** | **String** | The message displayed if the custom tab fails input validation (either custom of embedded). | [optional]
|
|
47
|
+
**validation_pattern** | **String** | A regular expressionn used to validate input for the tab. | [optional]
|
|
48
|
+
**value** | **String** | Specifies the value of the tab. | [optional]
|
|
49
|
+
**width** | **Integer** | Width of the tab in pixels. | [optional]
|
|
50
|
+
**x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
51
|
+
**y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
|
|
52
|
+
|
|
53
|
+
|
|
Binary file
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
|
2
|
+
#
|
|
3
|
+
=begin
|
|
4
|
+
#DocuSign REST API
|
|
5
|
+
|
|
6
|
+
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
|
7
|
+
|
|
8
|
+
OpenAPI spec version: v2
|
|
9
|
+
Contact: devcenter@docusign.com
|
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
|
+
|
|
12
|
+
=end
|
|
13
|
+
|
|
14
|
+
$:.push File.expand_path("../lib", __FILE__)
|
|
15
|
+
require "docusign_esign/version"
|
|
16
|
+
|
|
17
|
+
Gem::Specification.new do |s|
|
|
18
|
+
s.name = "docusign_esign"
|
|
19
|
+
s.version = DocuSign_eSign::VERSION
|
|
20
|
+
s.platform = Gem::Platform::RUBY
|
|
21
|
+
s.authors = ["Swagger-Codegen"]
|
|
22
|
+
s.email = ["devcenter@docusign.com"]
|
|
23
|
+
s.homepage = "https://github.com/swagger-api/swagger-codegen"
|
|
24
|
+
s.summary = "DocuSign REST API Ruby Gem"
|
|
25
|
+
s.description = "The DocuSign package makes integrating DocuSign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-ruby-client repository. Join the eSign revolution!"
|
|
26
|
+
# TODO uncommnet and update below with a proper license
|
|
27
|
+
#s.license = "Apache 2.0"
|
|
28
|
+
s.required_ruby_version = ">= 1.9"
|
|
29
|
+
|
|
30
|
+
s.add_dependency 'jwt', '~> 2.0', '>= 2.0.0'
|
|
31
|
+
|
|
32
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
|
33
|
+
s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
|
|
34
|
+
|
|
35
|
+
s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
|
|
36
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
|
37
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
|
38
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
|
39
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
|
40
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
|
41
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
|
|
42
|
+
|
|
43
|
+
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
|
|
44
|
+
s.test_files = `find spec/*`.split("\n")
|
|
45
|
+
s.executables = []
|
|
46
|
+
s.require_paths = ["lib"]
|
|
47
|
+
end
|
data/git_push.sh
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
#
|
|
3
|
+
# Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
4
|
+
#
|
|
5
|
+
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
|
|
6
|
+
#
|
|
7
|
+
# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
|
|
8
|
+
|
|
9
|
+
git_user_id=$1
|
|
10
|
+
git_repo_id=$2
|
|
11
|
+
release_note=$3
|
|
12
|
+
|
|
13
|
+
if [ "$git_user_id" = "" ]; then
|
|
14
|
+
git_user_id="GIT_USER_ID"
|
|
15
|
+
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
|
16
|
+
fi
|
|
17
|
+
|
|
18
|
+
if [ "$git_repo_id" = "" ]; then
|
|
19
|
+
git_repo_id="GIT_REPO_ID"
|
|
20
|
+
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
|
21
|
+
fi
|
|
22
|
+
|
|
23
|
+
if [ "$release_note" = "" ]; then
|
|
24
|
+
release_note="Minor update"
|
|
25
|
+
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
|
26
|
+
fi
|
|
27
|
+
|
|
28
|
+
# Initialize the local directory as a Git repository
|
|
29
|
+
git init
|
|
30
|
+
|
|
31
|
+
# Adds the files in the local repository and stages them for commit.
|
|
32
|
+
git add .
|
|
33
|
+
|
|
34
|
+
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
|
35
|
+
git commit -m "$release_note"
|
|
36
|
+
|
|
37
|
+
# Sets the new remote
|
|
38
|
+
git_remote=`git remote`
|
|
39
|
+
if [ "$git_remote" = "" ]; then # git remote not defined
|
|
40
|
+
|
|
41
|
+
if [ "$GIT_TOKEN" = "" ]; then
|
|
42
|
+
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
|
|
43
|
+
git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
|
|
44
|
+
else
|
|
45
|
+
git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
|
|
46
|
+
fi
|
|
47
|
+
|
|
48
|
+
fi
|
|
49
|
+
|
|
50
|
+
git pull origin master
|
|
51
|
+
|
|
52
|
+
# Pushes (Forces) the changes in the local repository up to the remote repository
|
|
53
|
+
echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
|
|
54
|
+
git push origin master 2>&1 | grep -v 'To https'
|
|
55
|
+
|
|
Binary file
|
|
@@ -0,0 +1,2230 @@
|
|
|
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 CreateOptions
|
|
17
|
+
# When set to **true**, creates the account using a preview billing plan.
|
|
18
|
+
attr_accessor :preview_billing_plan
|
|
19
|
+
|
|
20
|
+
def self.default
|
|
21
|
+
@@default ||= CreateOptions.new
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
class CreatePermissionProfileOptions
|
|
26
|
+
#
|
|
27
|
+
attr_accessor :include
|
|
28
|
+
|
|
29
|
+
def self.default
|
|
30
|
+
@@default ||= CreatePermissionProfileOptions.new
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
class GetAccountInformationOptions
|
|
35
|
+
# When set to **true**, includes the account settings for the account in the response.
|
|
36
|
+
attr_accessor :include_account_settings
|
|
37
|
+
|
|
38
|
+
def self.default
|
|
39
|
+
@@default ||= GetAccountInformationOptions.new
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
class GetBillingChargesOptions
|
|
44
|
+
# Specifies which billing charges to return. Valid values are: * envelopes * seats
|
|
45
|
+
attr_accessor :include_charges
|
|
46
|
+
|
|
47
|
+
def self.default
|
|
48
|
+
@@default ||= GetBillingChargesOptions.new
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
class GetBrandOptions
|
|
53
|
+
#
|
|
54
|
+
attr_accessor :include_external_references
|
|
55
|
+
|
|
56
|
+
#
|
|
57
|
+
attr_accessor :include_logos
|
|
58
|
+
|
|
59
|
+
def self.default
|
|
60
|
+
@@default ||= GetBrandOptions.new
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
class GetBrandResourcesByContentTypeOptions
|
|
65
|
+
#
|
|
66
|
+
attr_accessor :langcode
|
|
67
|
+
|
|
68
|
+
#
|
|
69
|
+
attr_accessor :return_master
|
|
70
|
+
|
|
71
|
+
def self.default
|
|
72
|
+
@@default ||= GetBrandResourcesByContentTypeOptions.new
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
class GetConsumerDisclosureDefaultOptions
|
|
77
|
+
# Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). Additionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
|
78
|
+
attr_accessor :lang_code
|
|
79
|
+
|
|
80
|
+
def self.default
|
|
81
|
+
@@default ||= GetConsumerDisclosureDefaultOptions.new
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
class GetPermissionProfileOptions
|
|
86
|
+
#
|
|
87
|
+
attr_accessor :include
|
|
88
|
+
|
|
89
|
+
def self.default
|
|
90
|
+
@@default ||= GetPermissionProfileOptions.new
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
class ListBrandsOptions
|
|
95
|
+
# When set to **true**, excludes distributor brand information from the response set.
|
|
96
|
+
attr_accessor :exclude_distributor_brand
|
|
97
|
+
|
|
98
|
+
# When set to **true**, returns the logos associated with the brand.
|
|
99
|
+
attr_accessor :include_logos
|
|
100
|
+
|
|
101
|
+
def self.default
|
|
102
|
+
@@default ||= ListBrandsOptions.new
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
class ListPermissionsOptions
|
|
107
|
+
#
|
|
108
|
+
attr_accessor :include
|
|
109
|
+
|
|
110
|
+
def self.default
|
|
111
|
+
@@default ||= ListPermissionsOptions.new
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
class ListRecipientNamesByEmailOptions
|
|
116
|
+
# The email address for the user
|
|
117
|
+
attr_accessor :email
|
|
118
|
+
|
|
119
|
+
def self.default
|
|
120
|
+
@@default ||= ListRecipientNamesByEmailOptions.new
|
|
121
|
+
end
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
class ListSharedAccessOptions
|
|
125
|
+
# Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
|
|
126
|
+
attr_accessor :count
|
|
127
|
+
|
|
128
|
+
#
|
|
129
|
+
attr_accessor :envelopes_not_shared_user_status
|
|
130
|
+
|
|
131
|
+
#
|
|
132
|
+
attr_accessor :folder_ids
|
|
133
|
+
|
|
134
|
+
# Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users.
|
|
135
|
+
attr_accessor :item_type
|
|
136
|
+
|
|
137
|
+
# This can be used to filter user names in the response. The wild-card ‘*’ (asterisk) can be used around the string.
|
|
138
|
+
attr_accessor :search_text
|
|
139
|
+
|
|
140
|
+
# Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user
|
|
141
|
+
attr_accessor :shared
|
|
142
|
+
|
|
143
|
+
# If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0.
|
|
144
|
+
attr_accessor :start_position
|
|
145
|
+
|
|
146
|
+
# A comma separated list of userIds for whom the shared item information is being requested.
|
|
147
|
+
attr_accessor :user_ids
|
|
148
|
+
|
|
149
|
+
def self.default
|
|
150
|
+
@@default ||= ListSharedAccessOptions.new
|
|
151
|
+
end
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
class UpdatePermissionProfileOptions
|
|
155
|
+
#
|
|
156
|
+
attr_accessor :include
|
|
157
|
+
|
|
158
|
+
def self.default
|
|
159
|
+
@@default ||= UpdatePermissionProfileOptions.new
|
|
160
|
+
end
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
class UpdateSharedAccessOptions
|
|
164
|
+
#
|
|
165
|
+
attr_accessor :item_type
|
|
166
|
+
|
|
167
|
+
#
|
|
168
|
+
attr_accessor :user_ids
|
|
169
|
+
|
|
170
|
+
def self.default
|
|
171
|
+
@@default ||= UpdateSharedAccessOptions.new
|
|
172
|
+
end
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
class AccountsApi
|
|
177
|
+
attr_accessor :api_client
|
|
178
|
+
|
|
179
|
+
def initialize(api_client = AccountsApi.default)
|
|
180
|
+
@api_client = api_client
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
# Creates new accounts.
|
|
184
|
+
# Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a `newAccountRequests` element. A maximum of 100 new accounts can be created at one time. Note that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed.
|
|
185
|
+
# @param new_account_definition (optional parameter)
|
|
186
|
+
# @param DocuSign_eSign::CreateOptions Options for modifying the behavior of the function.
|
|
187
|
+
# @return [NewAccountSummary]
|
|
188
|
+
def create(new_account_definition, options = DocuSign_eSign::CreateOptions.default)
|
|
189
|
+
data, _status_code, _headers = create_with_http_info( new_account_definition, options)
|
|
190
|
+
return data
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# Creates new accounts.
|
|
194
|
+
# Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a `newAccountRequests` element. A maximum of 100 new accounts can be created at one time. Note that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed.
|
|
195
|
+
# @param new_account_definition (optional parameter)
|
|
196
|
+
# @param DocuSign_eSign::CreateOptions Options for modifying the behavior of the function.
|
|
197
|
+
# @return [Array<(NewAccountSummary, Fixnum, Hash)>] NewAccountSummary data, response status code and response headers
|
|
198
|
+
def create_with_http_info(new_account_definition, options = DocuSign_eSign::CreateOptions.default)
|
|
199
|
+
if @api_client.config.debugging
|
|
200
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.create ..."
|
|
201
|
+
end
|
|
202
|
+
# resource path
|
|
203
|
+
local_var_path = "/v2/accounts".sub('{format}','json')
|
|
204
|
+
|
|
205
|
+
# query parameters
|
|
206
|
+
query_params = {}
|
|
207
|
+
query_params[:'preview_billing_plan'] = options.preview_billing_plan if !options.preview_billing_plan.nil?
|
|
208
|
+
|
|
209
|
+
# header parameters
|
|
210
|
+
header_params = {}
|
|
211
|
+
# HTTP header 'Accept' (if needed)
|
|
212
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
213
|
+
|
|
214
|
+
# form parameters
|
|
215
|
+
form_params = {}
|
|
216
|
+
|
|
217
|
+
# http body (model)
|
|
218
|
+
post_body = @api_client.object_to_http_body(new_account_definition)
|
|
219
|
+
auth_names = []
|
|
220
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
221
|
+
:header_params => header_params,
|
|
222
|
+
:query_params => query_params,
|
|
223
|
+
:form_params => form_params,
|
|
224
|
+
:body => post_body,
|
|
225
|
+
:auth_names => auth_names,
|
|
226
|
+
:return_type => 'NewAccountSummary')
|
|
227
|
+
if @api_client.config.debugging
|
|
228
|
+
@api_client.config.logger.debug "API called: AccountsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
229
|
+
end
|
|
230
|
+
return data, status_code, headers
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
# Creates one or more brand profile files for the account.
|
|
234
|
+
# Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
|
|
235
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
236
|
+
# @param brand (optional parameter)
|
|
237
|
+
# @return [BrandsResponse]
|
|
238
|
+
def create_brand(account_id, brand)
|
|
239
|
+
data, _status_code, _headers = create_brand_with_http_info(account_id, brand)
|
|
240
|
+
return data
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
# Creates one or more brand profile files for the account.
|
|
244
|
+
# Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
|
|
245
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
246
|
+
# @param brand (optional parameter)
|
|
247
|
+
# @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
|
|
248
|
+
def create_brand_with_http_info(account_id, brand)
|
|
249
|
+
if @api_client.config.debugging
|
|
250
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.create_brand ..."
|
|
251
|
+
end
|
|
252
|
+
# verify the required parameter 'account_id' is set
|
|
253
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_brand" if account_id.nil?
|
|
254
|
+
# resource path
|
|
255
|
+
local_var_path = "/v2/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
256
|
+
|
|
257
|
+
# query parameters
|
|
258
|
+
query_params = {}
|
|
259
|
+
|
|
260
|
+
# header parameters
|
|
261
|
+
header_params = {}
|
|
262
|
+
# HTTP header 'Accept' (if needed)
|
|
263
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
264
|
+
|
|
265
|
+
# form parameters
|
|
266
|
+
form_params = {}
|
|
267
|
+
|
|
268
|
+
# http body (model)
|
|
269
|
+
post_body = @api_client.object_to_http_body(brand)
|
|
270
|
+
auth_names = []
|
|
271
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
272
|
+
:header_params => header_params,
|
|
273
|
+
:query_params => query_params,
|
|
274
|
+
:form_params => form_params,
|
|
275
|
+
:body => post_body,
|
|
276
|
+
:auth_names => auth_names,
|
|
277
|
+
:return_type => 'BrandsResponse')
|
|
278
|
+
if @api_client.config.debugging
|
|
279
|
+
@api_client.config.logger.debug "API called: AccountsApi#create_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
280
|
+
end
|
|
281
|
+
return data, status_code, headers
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
# Starts a new eMortgage Transaction
|
|
285
|
+
#
|
|
286
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
287
|
+
# @param post_transactions_request (optional parameter)
|
|
288
|
+
# @return [PostTransactionsResponse]
|
|
289
|
+
def create_e_mortgage_transaction(account_id, post_transactions_request)
|
|
290
|
+
data, _status_code, _headers = create_e_mortgage_transaction_with_http_info(account_id, post_transactions_request)
|
|
291
|
+
return data
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
# Starts a new eMortgage Transaction
|
|
295
|
+
#
|
|
296
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
297
|
+
# @param post_transactions_request (optional parameter)
|
|
298
|
+
# @return [Array<(PostTransactionsResponse, Fixnum, Hash)>] PostTransactionsResponse data, response status code and response headers
|
|
299
|
+
def create_e_mortgage_transaction_with_http_info(account_id, post_transactions_request)
|
|
300
|
+
if @api_client.config.debugging
|
|
301
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.create_e_mortgage_transaction ..."
|
|
302
|
+
end
|
|
303
|
+
# verify the required parameter 'account_id' is set
|
|
304
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_e_mortgage_transaction" if account_id.nil?
|
|
305
|
+
# resource path
|
|
306
|
+
local_var_path = "/v2/accounts/{accountId}/eMortgage/transactions".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
307
|
+
|
|
308
|
+
# query parameters
|
|
309
|
+
query_params = {}
|
|
310
|
+
|
|
311
|
+
# header parameters
|
|
312
|
+
header_params = {}
|
|
313
|
+
# HTTP header 'Accept' (if needed)
|
|
314
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
315
|
+
|
|
316
|
+
# form parameters
|
|
317
|
+
form_params = {}
|
|
318
|
+
|
|
319
|
+
# http body (model)
|
|
320
|
+
post_body = @api_client.object_to_http_body(post_transactions_request)
|
|
321
|
+
auth_names = []
|
|
322
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
323
|
+
:header_params => header_params,
|
|
324
|
+
:query_params => query_params,
|
|
325
|
+
:form_params => form_params,
|
|
326
|
+
:body => post_body,
|
|
327
|
+
:auth_names => auth_names,
|
|
328
|
+
:return_type => 'PostTransactionsResponse')
|
|
329
|
+
if @api_client.config.debugging
|
|
330
|
+
@api_client.config.logger.debug "API called: AccountsApi#create_e_mortgage_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
331
|
+
end
|
|
332
|
+
return data, status_code, headers
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
# Creates a new permission profile in the specified account.
|
|
336
|
+
#
|
|
337
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
338
|
+
# @param permission_profile (optional parameter)
|
|
339
|
+
# @param DocuSign_eSign::CreatePermissionProfileOptions Options for modifying the behavior of the function.
|
|
340
|
+
# @return [PermissionProfile]
|
|
341
|
+
def create_permission_profile(account_id, permission_profile, options = DocuSign_eSign::CreatePermissionProfileOptions.default)
|
|
342
|
+
data, _status_code, _headers = create_permission_profile_with_http_info(account_id, permission_profile, options)
|
|
343
|
+
return data
|
|
344
|
+
end
|
|
345
|
+
|
|
346
|
+
# Creates a new permission profile in the specified account.
|
|
347
|
+
#
|
|
348
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
349
|
+
# @param permission_profile (optional parameter)
|
|
350
|
+
# @param DocuSign_eSign::CreatePermissionProfileOptions Options for modifying the behavior of the function.
|
|
351
|
+
# @return [Array<(PermissionProfile, Fixnum, Hash)>] PermissionProfile data, response status code and response headers
|
|
352
|
+
def create_permission_profile_with_http_info(account_id, permission_profile, options = DocuSign_eSign::CreatePermissionProfileOptions.default)
|
|
353
|
+
if @api_client.config.debugging
|
|
354
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.create_permission_profile ..."
|
|
355
|
+
end
|
|
356
|
+
# verify the required parameter 'account_id' is set
|
|
357
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_permission_profile" if account_id.nil?
|
|
358
|
+
# resource path
|
|
359
|
+
local_var_path = "/v2/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
360
|
+
|
|
361
|
+
# query parameters
|
|
362
|
+
query_params = {}
|
|
363
|
+
query_params[:'include'] = options.include if !options.include.nil?
|
|
364
|
+
|
|
365
|
+
# header parameters
|
|
366
|
+
header_params = {}
|
|
367
|
+
# HTTP header 'Accept' (if needed)
|
|
368
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
369
|
+
|
|
370
|
+
# form parameters
|
|
371
|
+
form_params = {}
|
|
372
|
+
|
|
373
|
+
# http body (model)
|
|
374
|
+
post_body = @api_client.object_to_http_body(permission_profile)
|
|
375
|
+
auth_names = []
|
|
376
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
377
|
+
:header_params => header_params,
|
|
378
|
+
:query_params => query_params,
|
|
379
|
+
:form_params => form_params,
|
|
380
|
+
:body => post_body,
|
|
381
|
+
:auth_names => auth_names,
|
|
382
|
+
:return_type => 'PermissionProfile')
|
|
383
|
+
if @api_client.config.debugging
|
|
384
|
+
@api_client.config.logger.debug "API called: AccountsApi#create_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
385
|
+
end
|
|
386
|
+
return data, status_code, headers
|
|
387
|
+
end
|
|
388
|
+
|
|
389
|
+
# Deletes the specified account.
|
|
390
|
+
# This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
|
|
391
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
392
|
+
# @return [nil]
|
|
393
|
+
def delete(account_id)
|
|
394
|
+
delete_with_http_info(account_id)
|
|
395
|
+
return nil
|
|
396
|
+
end
|
|
397
|
+
|
|
398
|
+
# Deletes the specified account.
|
|
399
|
+
# This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
|
|
400
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
401
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
402
|
+
def delete_with_http_info(account_id)
|
|
403
|
+
if @api_client.config.debugging
|
|
404
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete ..."
|
|
405
|
+
end
|
|
406
|
+
# verify the required parameter 'account_id' is set
|
|
407
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete" if account_id.nil?
|
|
408
|
+
# resource path
|
|
409
|
+
local_var_path = "/v2/accounts/{accountId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
410
|
+
|
|
411
|
+
# query parameters
|
|
412
|
+
query_params = {}
|
|
413
|
+
|
|
414
|
+
# header parameters
|
|
415
|
+
header_params = {}
|
|
416
|
+
# HTTP header 'Accept' (if needed)
|
|
417
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
418
|
+
|
|
419
|
+
# form parameters
|
|
420
|
+
form_params = {}
|
|
421
|
+
|
|
422
|
+
# http body (model)
|
|
423
|
+
post_body = nil
|
|
424
|
+
auth_names = []
|
|
425
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
426
|
+
:header_params => header_params,
|
|
427
|
+
:query_params => query_params,
|
|
428
|
+
:form_params => form_params,
|
|
429
|
+
:body => post_body,
|
|
430
|
+
:auth_names => auth_names)
|
|
431
|
+
if @api_client.config.debugging
|
|
432
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
433
|
+
end
|
|
434
|
+
return data, status_code, headers
|
|
435
|
+
end
|
|
436
|
+
|
|
437
|
+
# Removes a brand.
|
|
438
|
+
#
|
|
439
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
440
|
+
# @param brand_id The unique identifier of a brand.
|
|
441
|
+
# @return [nil]
|
|
442
|
+
def delete_brand(account_id, brand_id)
|
|
443
|
+
delete_brand_with_http_info(account_id, brand_id)
|
|
444
|
+
return nil
|
|
445
|
+
end
|
|
446
|
+
|
|
447
|
+
# Removes a brand.
|
|
448
|
+
#
|
|
449
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
450
|
+
# @param brand_id The unique identifier of a brand.
|
|
451
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
452
|
+
def delete_brand_with_http_info(account_id, brand_id)
|
|
453
|
+
if @api_client.config.debugging
|
|
454
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_brand ..."
|
|
455
|
+
end
|
|
456
|
+
# verify the required parameter 'account_id' is set
|
|
457
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brand" if account_id.nil?
|
|
458
|
+
# verify the required parameter 'brand_id' is set
|
|
459
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.delete_brand" if brand_id.nil?
|
|
460
|
+
# resource path
|
|
461
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_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 = nil
|
|
476
|
+
auth_names = []
|
|
477
|
+
data, status_code, headers = @api_client.call_api(:DELETE, 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
|
+
if @api_client.config.debugging
|
|
484
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
485
|
+
end
|
|
486
|
+
return data, status_code, headers
|
|
487
|
+
end
|
|
488
|
+
|
|
489
|
+
# Delete one branding logo.
|
|
490
|
+
#
|
|
491
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
492
|
+
# @param brand_id The unique identifier of a brand.
|
|
493
|
+
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
|
494
|
+
# @return [nil]
|
|
495
|
+
def delete_brand_logo_by_type(account_id, brand_id, logo_type)
|
|
496
|
+
delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
|
497
|
+
return nil
|
|
498
|
+
end
|
|
499
|
+
|
|
500
|
+
# Delete one branding logo.
|
|
501
|
+
#
|
|
502
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
503
|
+
# @param brand_id The unique identifier of a brand.
|
|
504
|
+
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
|
505
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
506
|
+
def delete_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
|
507
|
+
if @api_client.config.debugging
|
|
508
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_brand_logo_by_type ..."
|
|
509
|
+
end
|
|
510
|
+
# verify the required parameter 'account_id' is set
|
|
511
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brand_logo_by_type" if account_id.nil?
|
|
512
|
+
# verify the required parameter 'brand_id' is set
|
|
513
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.delete_brand_logo_by_type" if brand_id.nil?
|
|
514
|
+
# verify the required parameter 'logo_type' is set
|
|
515
|
+
fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.delete_brand_logo_by_type" if logo_type.nil?
|
|
516
|
+
# resource path
|
|
517
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)
|
|
518
|
+
|
|
519
|
+
# query parameters
|
|
520
|
+
query_params = {}
|
|
521
|
+
|
|
522
|
+
# header parameters
|
|
523
|
+
header_params = {}
|
|
524
|
+
# HTTP header 'Accept' (if needed)
|
|
525
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
526
|
+
|
|
527
|
+
# form parameters
|
|
528
|
+
form_params = {}
|
|
529
|
+
|
|
530
|
+
# http body (model)
|
|
531
|
+
post_body = nil
|
|
532
|
+
auth_names = []
|
|
533
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
534
|
+
:header_params => header_params,
|
|
535
|
+
:query_params => query_params,
|
|
536
|
+
:form_params => form_params,
|
|
537
|
+
:body => post_body,
|
|
538
|
+
:auth_names => auth_names)
|
|
539
|
+
if @api_client.config.debugging
|
|
540
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
541
|
+
end
|
|
542
|
+
return data, status_code, headers
|
|
543
|
+
end
|
|
544
|
+
|
|
545
|
+
# Deletes one or more brand profiles.
|
|
546
|
+
# Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** to use this call.
|
|
547
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
548
|
+
# @param brands_request (optional parameter)
|
|
549
|
+
# @return [BrandsResponse]
|
|
550
|
+
def delete_brands(account_id, brands_request)
|
|
551
|
+
data, _status_code, _headers = delete_brands_with_http_info(account_id, brands_request)
|
|
552
|
+
return data
|
|
553
|
+
end
|
|
554
|
+
|
|
555
|
+
# Deletes one or more brand profiles.
|
|
556
|
+
# Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** to use this call.
|
|
557
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
558
|
+
# @param brands_request (optional parameter)
|
|
559
|
+
# @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
|
|
560
|
+
def delete_brands_with_http_info(account_id, brands_request)
|
|
561
|
+
if @api_client.config.debugging
|
|
562
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_brands ..."
|
|
563
|
+
end
|
|
564
|
+
# verify the required parameter 'account_id' is set
|
|
565
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brands" if account_id.nil?
|
|
566
|
+
# resource path
|
|
567
|
+
local_var_path = "/v2/accounts/{accountId}/brands".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(brands_request)
|
|
582
|
+
auth_names = []
|
|
583
|
+
data, status_code, headers = @api_client.call_api(:DELETE, 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 => 'BrandsResponse')
|
|
590
|
+
if @api_client.config.debugging
|
|
591
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
592
|
+
end
|
|
593
|
+
return data, status_code, headers
|
|
594
|
+
end
|
|
595
|
+
|
|
596
|
+
# Deletes the signature for one or more captive recipient records.
|
|
597
|
+
# Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.
|
|
598
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
599
|
+
# @param recipient_part
|
|
600
|
+
# @param captive_recipient_information (optional parameter)
|
|
601
|
+
# @return [CaptiveRecipientInformation]
|
|
602
|
+
def delete_captive_recipient(account_id, recipient_part, captive_recipient_information)
|
|
603
|
+
data, _status_code, _headers = delete_captive_recipient_with_http_info(account_id, recipient_part, captive_recipient_information)
|
|
604
|
+
return data
|
|
605
|
+
end
|
|
606
|
+
|
|
607
|
+
# Deletes the signature for one or more captive recipient records.
|
|
608
|
+
# Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.
|
|
609
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
610
|
+
# @param recipient_part
|
|
611
|
+
# @param captive_recipient_information (optional parameter)
|
|
612
|
+
# @return [Array<(CaptiveRecipientInformation, Fixnum, Hash)>] CaptiveRecipientInformation data, response status code and response headers
|
|
613
|
+
def delete_captive_recipient_with_http_info(account_id, recipient_part, captive_recipient_information)
|
|
614
|
+
if @api_client.config.debugging
|
|
615
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_captive_recipient ..."
|
|
616
|
+
end
|
|
617
|
+
# verify the required parameter 'account_id' is set
|
|
618
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_captive_recipient" if account_id.nil?
|
|
619
|
+
# verify the required parameter 'recipient_part' is set
|
|
620
|
+
fail ArgumentError, "Missing the required parameter 'recipient_part' when calling AccountsApi.delete_captive_recipient" if recipient_part.nil?
|
|
621
|
+
# resource path
|
|
622
|
+
local_var_path = "/v2/accounts/{accountId}/captive_recipients/{recipientPart}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientPart' + '}', recipient_part.to_s)
|
|
623
|
+
|
|
624
|
+
# query parameters
|
|
625
|
+
query_params = {}
|
|
626
|
+
|
|
627
|
+
# header parameters
|
|
628
|
+
header_params = {}
|
|
629
|
+
# HTTP header 'Accept' (if needed)
|
|
630
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
631
|
+
|
|
632
|
+
# form parameters
|
|
633
|
+
form_params = {}
|
|
634
|
+
|
|
635
|
+
# http body (model)
|
|
636
|
+
post_body = @api_client.object_to_http_body(captive_recipient_information)
|
|
637
|
+
auth_names = []
|
|
638
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
639
|
+
:header_params => header_params,
|
|
640
|
+
:query_params => query_params,
|
|
641
|
+
:form_params => form_params,
|
|
642
|
+
:body => post_body,
|
|
643
|
+
:auth_names => auth_names,
|
|
644
|
+
:return_type => 'CaptiveRecipientInformation')
|
|
645
|
+
if @api_client.config.debugging
|
|
646
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_captive_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
647
|
+
end
|
|
648
|
+
return data, status_code, headers
|
|
649
|
+
end
|
|
650
|
+
|
|
651
|
+
# Deletes configuration information for the eNote eOriginal integration.
|
|
652
|
+
#
|
|
653
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
654
|
+
# @return [nil]
|
|
655
|
+
def delete_e_note_configuration(account_id)
|
|
656
|
+
delete_e_note_configuration_with_http_info(account_id)
|
|
657
|
+
return nil
|
|
658
|
+
end
|
|
659
|
+
|
|
660
|
+
# Deletes configuration information for the eNote eOriginal integration.
|
|
661
|
+
#
|
|
662
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
663
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
664
|
+
def delete_e_note_configuration_with_http_info(account_id)
|
|
665
|
+
if @api_client.config.debugging
|
|
666
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_e_note_configuration ..."
|
|
667
|
+
end
|
|
668
|
+
# verify the required parameter 'account_id' is set
|
|
669
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_e_note_configuration" if account_id.nil?
|
|
670
|
+
# resource path
|
|
671
|
+
local_var_path = "/v2/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
672
|
+
|
|
673
|
+
# query parameters
|
|
674
|
+
query_params = {}
|
|
675
|
+
|
|
676
|
+
# header parameters
|
|
677
|
+
header_params = {}
|
|
678
|
+
# HTTP header 'Accept' (if needed)
|
|
679
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
680
|
+
|
|
681
|
+
# form parameters
|
|
682
|
+
form_params = {}
|
|
683
|
+
|
|
684
|
+
# http body (model)
|
|
685
|
+
post_body = nil
|
|
686
|
+
auth_names = []
|
|
687
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
688
|
+
:header_params => header_params,
|
|
689
|
+
:query_params => query_params,
|
|
690
|
+
:form_params => form_params,
|
|
691
|
+
:body => post_body,
|
|
692
|
+
:auth_names => auth_names)
|
|
693
|
+
if @api_client.config.debugging
|
|
694
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_e_note_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
695
|
+
end
|
|
696
|
+
return data, status_code, headers
|
|
697
|
+
end
|
|
698
|
+
|
|
699
|
+
# Deletes a permissions profile within the specified account.
|
|
700
|
+
#
|
|
701
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
702
|
+
# @param permission_profile_id
|
|
703
|
+
# @return [nil]
|
|
704
|
+
def delete_permission_profile(account_id, permission_profile_id)
|
|
705
|
+
delete_permission_profile_with_http_info(account_id, permission_profile_id)
|
|
706
|
+
return nil
|
|
707
|
+
end
|
|
708
|
+
|
|
709
|
+
# Deletes a permissions profile within the specified account.
|
|
710
|
+
#
|
|
711
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
712
|
+
# @param permission_profile_id
|
|
713
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
714
|
+
def delete_permission_profile_with_http_info(account_id, permission_profile_id)
|
|
715
|
+
if @api_client.config.debugging
|
|
716
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_permission_profile ..."
|
|
717
|
+
end
|
|
718
|
+
# verify the required parameter 'account_id' is set
|
|
719
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_permission_profile" if account_id.nil?
|
|
720
|
+
# verify the required parameter 'permission_profile_id' is set
|
|
721
|
+
fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.delete_permission_profile" if permission_profile_id.nil?
|
|
722
|
+
# resource path
|
|
723
|
+
local_var_path = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)
|
|
724
|
+
|
|
725
|
+
# query parameters
|
|
726
|
+
query_params = {}
|
|
727
|
+
|
|
728
|
+
# header parameters
|
|
729
|
+
header_params = {}
|
|
730
|
+
# HTTP header 'Accept' (if needed)
|
|
731
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
732
|
+
|
|
733
|
+
# form parameters
|
|
734
|
+
form_params = {}
|
|
735
|
+
|
|
736
|
+
# http body (model)
|
|
737
|
+
post_body = nil
|
|
738
|
+
auth_names = []
|
|
739
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
740
|
+
:header_params => header_params,
|
|
741
|
+
:query_params => query_params,
|
|
742
|
+
:form_params => form_params,
|
|
743
|
+
:body => post_body,
|
|
744
|
+
:auth_names => auth_names)
|
|
745
|
+
if @api_client.config.debugging
|
|
746
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
747
|
+
end
|
|
748
|
+
return data, status_code, headers
|
|
749
|
+
end
|
|
750
|
+
|
|
751
|
+
# Retrieves the account information for the specified account.
|
|
752
|
+
# Retrieves the account information for the specified account. **Response** The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.
|
|
753
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
754
|
+
# @param DocuSign_eSign::GetAccountInformationOptions Options for modifying the behavior of the function.
|
|
755
|
+
# @return [AccountInformation]
|
|
756
|
+
def get_account_information(account_id, options = DocuSign_eSign::GetAccountInformationOptions.default)
|
|
757
|
+
data, _status_code, _headers = get_account_information_with_http_info(account_id, options)
|
|
758
|
+
return data
|
|
759
|
+
end
|
|
760
|
+
|
|
761
|
+
# Retrieves the account information for the specified account.
|
|
762
|
+
# Retrieves the account information for the specified account. **Response** The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.
|
|
763
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
764
|
+
# @param DocuSign_eSign::GetAccountInformationOptions Options for modifying the behavior of the function.
|
|
765
|
+
# @return [Array<(AccountInformation, Fixnum, Hash)>] AccountInformation data, response status code and response headers
|
|
766
|
+
def get_account_information_with_http_info(account_id, options = DocuSign_eSign::GetAccountInformationOptions.default)
|
|
767
|
+
if @api_client.config.debugging
|
|
768
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_account_information ..."
|
|
769
|
+
end
|
|
770
|
+
# verify the required parameter 'account_id' is set
|
|
771
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_information" if account_id.nil?
|
|
772
|
+
# resource path
|
|
773
|
+
local_var_path = "/v2/accounts/{accountId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
774
|
+
|
|
775
|
+
# query parameters
|
|
776
|
+
query_params = {}
|
|
777
|
+
query_params[:'include_account_settings'] = options.include_account_settings if !options.include_account_settings.nil?
|
|
778
|
+
|
|
779
|
+
# header parameters
|
|
780
|
+
header_params = {}
|
|
781
|
+
# HTTP header 'Accept' (if needed)
|
|
782
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
783
|
+
|
|
784
|
+
# form parameters
|
|
785
|
+
form_params = {}
|
|
786
|
+
|
|
787
|
+
# http body (model)
|
|
788
|
+
post_body = nil
|
|
789
|
+
auth_names = []
|
|
790
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
791
|
+
:header_params => header_params,
|
|
792
|
+
:query_params => query_params,
|
|
793
|
+
:form_params => form_params,
|
|
794
|
+
:body => post_body,
|
|
795
|
+
:auth_names => auth_names,
|
|
796
|
+
:return_type => 'AccountInformation')
|
|
797
|
+
if @api_client.config.debugging
|
|
798
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_account_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
799
|
+
end
|
|
800
|
+
return data, status_code, headers
|
|
801
|
+
end
|
|
802
|
+
|
|
803
|
+
# Returns tab settings list for specified account
|
|
804
|
+
#
|
|
805
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
806
|
+
# @return [TabAccountSettings]
|
|
807
|
+
def get_account_tab_settings(account_id)
|
|
808
|
+
data, _status_code, _headers = get_account_tab_settings_with_http_info(account_id)
|
|
809
|
+
return data
|
|
810
|
+
end
|
|
811
|
+
|
|
812
|
+
# Returns tab settings list for specified account
|
|
813
|
+
#
|
|
814
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
815
|
+
# @return [Array<(TabAccountSettings, Fixnum, Hash)>] TabAccountSettings data, response status code and response headers
|
|
816
|
+
def get_account_tab_settings_with_http_info(account_id)
|
|
817
|
+
if @api_client.config.debugging
|
|
818
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_account_tab_settings ..."
|
|
819
|
+
end
|
|
820
|
+
# verify the required parameter 'account_id' is set
|
|
821
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_tab_settings" if account_id.nil?
|
|
822
|
+
# resource path
|
|
823
|
+
local_var_path = "/v2/accounts/{accountId}/settings/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
824
|
+
|
|
825
|
+
# query parameters
|
|
826
|
+
query_params = {}
|
|
827
|
+
|
|
828
|
+
# header parameters
|
|
829
|
+
header_params = {}
|
|
830
|
+
# HTTP header 'Accept' (if needed)
|
|
831
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
832
|
+
|
|
833
|
+
# form parameters
|
|
834
|
+
form_params = {}
|
|
835
|
+
|
|
836
|
+
# http body (model)
|
|
837
|
+
post_body = nil
|
|
838
|
+
auth_names = []
|
|
839
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
840
|
+
:header_params => header_params,
|
|
841
|
+
:query_params => query_params,
|
|
842
|
+
:form_params => form_params,
|
|
843
|
+
:body => post_body,
|
|
844
|
+
:auth_names => auth_names,
|
|
845
|
+
:return_type => 'TabAccountSettings')
|
|
846
|
+
if @api_client.config.debugging
|
|
847
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_account_tab_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
848
|
+
end
|
|
849
|
+
return data, status_code, headers
|
|
850
|
+
end
|
|
851
|
+
|
|
852
|
+
# Gets list of recurring and usage charges for the account.
|
|
853
|
+
# Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator
|
|
854
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
855
|
+
# @param DocuSign_eSign::GetBillingChargesOptions Options for modifying the behavior of the function.
|
|
856
|
+
# @return [BillingChargeResponse]
|
|
857
|
+
def get_billing_charges(account_id, options = DocuSign_eSign::GetBillingChargesOptions.default)
|
|
858
|
+
data, _status_code, _headers = get_billing_charges_with_http_info(account_id, options)
|
|
859
|
+
return data
|
|
860
|
+
end
|
|
861
|
+
|
|
862
|
+
# Gets list of recurring and usage charges for the account.
|
|
863
|
+
# Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator
|
|
864
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
865
|
+
# @param DocuSign_eSign::GetBillingChargesOptions Options for modifying the behavior of the function.
|
|
866
|
+
# @return [Array<(BillingChargeResponse, Fixnum, Hash)>] BillingChargeResponse data, response status code and response headers
|
|
867
|
+
def get_billing_charges_with_http_info(account_id, options = DocuSign_eSign::GetBillingChargesOptions.default)
|
|
868
|
+
if @api_client.config.debugging
|
|
869
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_billing_charges ..."
|
|
870
|
+
end
|
|
871
|
+
# verify the required parameter 'account_id' is set
|
|
872
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_billing_charges" if account_id.nil?
|
|
873
|
+
# resource path
|
|
874
|
+
local_var_path = "/v2/accounts/{accountId}/billing_charges".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
875
|
+
|
|
876
|
+
# query parameters
|
|
877
|
+
query_params = {}
|
|
878
|
+
query_params[:'include_charges'] = options.include_charges if !options.include_charges.nil?
|
|
879
|
+
|
|
880
|
+
# header parameters
|
|
881
|
+
header_params = {}
|
|
882
|
+
# HTTP header 'Accept' (if needed)
|
|
883
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
884
|
+
|
|
885
|
+
# form parameters
|
|
886
|
+
form_params = {}
|
|
887
|
+
|
|
888
|
+
# http body (model)
|
|
889
|
+
post_body = nil
|
|
890
|
+
auth_names = []
|
|
891
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
892
|
+
:header_params => header_params,
|
|
893
|
+
:query_params => query_params,
|
|
894
|
+
:form_params => form_params,
|
|
895
|
+
:body => post_body,
|
|
896
|
+
:auth_names => auth_names,
|
|
897
|
+
:return_type => 'BillingChargeResponse')
|
|
898
|
+
if @api_client.config.debugging
|
|
899
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_billing_charges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
900
|
+
end
|
|
901
|
+
return data, status_code, headers
|
|
902
|
+
end
|
|
903
|
+
|
|
904
|
+
# Get information for a specific brand.
|
|
905
|
+
#
|
|
906
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
907
|
+
# @param brand_id The unique identifier of a brand.
|
|
908
|
+
# @param DocuSign_eSign::GetBrandOptions Options for modifying the behavior of the function.
|
|
909
|
+
# @return [Brand]
|
|
910
|
+
def get_brand(account_id, brand_id, options = DocuSign_eSign::GetBrandOptions.default)
|
|
911
|
+
data, _status_code, _headers = get_brand_with_http_info(account_id, brand_id, options)
|
|
912
|
+
return data
|
|
913
|
+
end
|
|
914
|
+
|
|
915
|
+
# Get information for a specific brand.
|
|
916
|
+
#
|
|
917
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
918
|
+
# @param brand_id The unique identifier of a brand.
|
|
919
|
+
# @param DocuSign_eSign::GetBrandOptions Options for modifying the behavior of the function.
|
|
920
|
+
# @return [Array<(Brand, Fixnum, Hash)>] Brand data, response status code and response headers
|
|
921
|
+
def get_brand_with_http_info(account_id, brand_id, options = DocuSign_eSign::GetBrandOptions.default)
|
|
922
|
+
if @api_client.config.debugging
|
|
923
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_brand ..."
|
|
924
|
+
end
|
|
925
|
+
# verify the required parameter 'account_id' is set
|
|
926
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand" if account_id.nil?
|
|
927
|
+
# verify the required parameter 'brand_id' is set
|
|
928
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand" if brand_id.nil?
|
|
929
|
+
# resource path
|
|
930
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
|
931
|
+
|
|
932
|
+
# query parameters
|
|
933
|
+
query_params = {}
|
|
934
|
+
query_params[:'include_external_references'] = options.include_external_references if !options.include_external_references.nil?
|
|
935
|
+
query_params[:'include_logos'] = options.include_logos if !options.include_logos.nil?
|
|
936
|
+
|
|
937
|
+
# header parameters
|
|
938
|
+
header_params = {}
|
|
939
|
+
# HTTP header 'Accept' (if needed)
|
|
940
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
941
|
+
|
|
942
|
+
# form parameters
|
|
943
|
+
form_params = {}
|
|
944
|
+
|
|
945
|
+
# http body (model)
|
|
946
|
+
post_body = nil
|
|
947
|
+
auth_names = []
|
|
948
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
949
|
+
:header_params => header_params,
|
|
950
|
+
:query_params => query_params,
|
|
951
|
+
:form_params => form_params,
|
|
952
|
+
:body => post_body,
|
|
953
|
+
:auth_names => auth_names,
|
|
954
|
+
:return_type => 'Brand')
|
|
955
|
+
if @api_client.config.debugging
|
|
956
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
957
|
+
end
|
|
958
|
+
return data, status_code, headers
|
|
959
|
+
end
|
|
960
|
+
|
|
961
|
+
# Obtains the specified image for a brand.
|
|
962
|
+
#
|
|
963
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
964
|
+
# @param brand_id The unique identifier of a brand.
|
|
965
|
+
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
|
966
|
+
# @return [nil]
|
|
967
|
+
def get_brand_logo_by_type(account_id, brand_id, logo_type)
|
|
968
|
+
get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
|
969
|
+
return nil
|
|
970
|
+
end
|
|
971
|
+
|
|
972
|
+
# Obtains the specified image for a brand.
|
|
973
|
+
#
|
|
974
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
975
|
+
# @param brand_id The unique identifier of a brand.
|
|
976
|
+
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
|
977
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
978
|
+
def get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
|
979
|
+
if @api_client.config.debugging
|
|
980
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_brand_logo_by_type ..."
|
|
981
|
+
end
|
|
982
|
+
# verify the required parameter 'account_id' is set
|
|
983
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_logo_by_type" if account_id.nil?
|
|
984
|
+
# verify the required parameter 'brand_id' is set
|
|
985
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_logo_by_type" if brand_id.nil?
|
|
986
|
+
# verify the required parameter 'logo_type' is set
|
|
987
|
+
fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.get_brand_logo_by_type" if logo_type.nil?
|
|
988
|
+
# resource path
|
|
989
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)
|
|
990
|
+
|
|
991
|
+
# query parameters
|
|
992
|
+
query_params = {}
|
|
993
|
+
|
|
994
|
+
# header parameters
|
|
995
|
+
header_params = {}
|
|
996
|
+
# HTTP header 'Accept' (if needed)
|
|
997
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
998
|
+
|
|
999
|
+
# form parameters
|
|
1000
|
+
form_params = {}
|
|
1001
|
+
|
|
1002
|
+
# http body (model)
|
|
1003
|
+
post_body = nil
|
|
1004
|
+
auth_names = []
|
|
1005
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1006
|
+
:header_params => header_params,
|
|
1007
|
+
:query_params => query_params,
|
|
1008
|
+
:form_params => form_params,
|
|
1009
|
+
:body => post_body,
|
|
1010
|
+
:auth_names => auth_names)
|
|
1011
|
+
if @api_client.config.debugging
|
|
1012
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1013
|
+
end
|
|
1014
|
+
return data, status_code, headers
|
|
1015
|
+
end
|
|
1016
|
+
|
|
1017
|
+
# Returns the specified account's list of branding resources (metadata).
|
|
1018
|
+
#
|
|
1019
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1020
|
+
# @param brand_id The unique identifier of a brand.
|
|
1021
|
+
# @return [BrandResourcesList]
|
|
1022
|
+
def get_brand_resources(account_id, brand_id)
|
|
1023
|
+
data, _status_code, _headers = get_brand_resources_with_http_info(account_id, brand_id)
|
|
1024
|
+
return data
|
|
1025
|
+
end
|
|
1026
|
+
|
|
1027
|
+
# Returns the specified account's list of branding resources (metadata).
|
|
1028
|
+
#
|
|
1029
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1030
|
+
# @param brand_id The unique identifier of a brand.
|
|
1031
|
+
# @return [Array<(BrandResourcesList, Fixnum, Hash)>] BrandResourcesList data, response status code and response headers
|
|
1032
|
+
def get_brand_resources_with_http_info(account_id, brand_id)
|
|
1033
|
+
if @api_client.config.debugging
|
|
1034
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_brand_resources ..."
|
|
1035
|
+
end
|
|
1036
|
+
# verify the required parameter 'account_id' is set
|
|
1037
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_resources" if account_id.nil?
|
|
1038
|
+
# verify the required parameter 'brand_id' is set
|
|
1039
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_resources" if brand_id.nil?
|
|
1040
|
+
# resource path
|
|
1041
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/resources".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
|
1042
|
+
|
|
1043
|
+
# query parameters
|
|
1044
|
+
query_params = {}
|
|
1045
|
+
|
|
1046
|
+
# header parameters
|
|
1047
|
+
header_params = {}
|
|
1048
|
+
# HTTP header 'Accept' (if needed)
|
|
1049
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1050
|
+
|
|
1051
|
+
# form parameters
|
|
1052
|
+
form_params = {}
|
|
1053
|
+
|
|
1054
|
+
# http body (model)
|
|
1055
|
+
post_body = nil
|
|
1056
|
+
auth_names = []
|
|
1057
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1058
|
+
:header_params => header_params,
|
|
1059
|
+
:query_params => query_params,
|
|
1060
|
+
:form_params => form_params,
|
|
1061
|
+
:body => post_body,
|
|
1062
|
+
:auth_names => auth_names,
|
|
1063
|
+
:return_type => 'BrandResourcesList')
|
|
1064
|
+
if @api_client.config.debugging
|
|
1065
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_brand_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1066
|
+
end
|
|
1067
|
+
return data, status_code, headers
|
|
1068
|
+
end
|
|
1069
|
+
|
|
1070
|
+
# Returns the specified branding resource file.
|
|
1071
|
+
#
|
|
1072
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1073
|
+
# @param brand_id The unique identifier of a brand.
|
|
1074
|
+
# @param resource_content_type
|
|
1075
|
+
# @param DocuSign_eSign::GetBrandResourcesByContentTypeOptions Options for modifying the behavior of the function.
|
|
1076
|
+
# @return [nil]
|
|
1077
|
+
def get_brand_resources_by_content_type(account_id, brand_id, resource_content_type, options = DocuSign_eSign::GetBrandResourcesByContentTypeOptions.default)
|
|
1078
|
+
get_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, options)
|
|
1079
|
+
return nil
|
|
1080
|
+
end
|
|
1081
|
+
|
|
1082
|
+
# Returns the specified branding resource file.
|
|
1083
|
+
#
|
|
1084
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1085
|
+
# @param brand_id The unique identifier of a brand.
|
|
1086
|
+
# @param resource_content_type
|
|
1087
|
+
# @param DocuSign_eSign::GetBrandResourcesByContentTypeOptions Options for modifying the behavior of the function.
|
|
1088
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1089
|
+
def get_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type, options = DocuSign_eSign::GetBrandResourcesByContentTypeOptions.default)
|
|
1090
|
+
if @api_client.config.debugging
|
|
1091
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_brand_resources_by_content_type ..."
|
|
1092
|
+
end
|
|
1093
|
+
# verify the required parameter 'account_id' is set
|
|
1094
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_resources_by_content_type" if account_id.nil?
|
|
1095
|
+
# verify the required parameter 'brand_id' is set
|
|
1096
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_resources_by_content_type" if brand_id.nil?
|
|
1097
|
+
# verify the required parameter 'resource_content_type' is set
|
|
1098
|
+
fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.get_brand_resources_by_content_type" if resource_content_type.nil?
|
|
1099
|
+
# resource path
|
|
1100
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)
|
|
1101
|
+
|
|
1102
|
+
# query parameters
|
|
1103
|
+
query_params = {}
|
|
1104
|
+
query_params[:'langcode'] = options.langcode if !options.langcode.nil?
|
|
1105
|
+
query_params[:'return_master'] = options.return_master if !options.return_master.nil?
|
|
1106
|
+
|
|
1107
|
+
# header parameters
|
|
1108
|
+
header_params = {}
|
|
1109
|
+
# HTTP header 'Accept' (if needed)
|
|
1110
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1111
|
+
|
|
1112
|
+
# form parameters
|
|
1113
|
+
form_params = {}
|
|
1114
|
+
|
|
1115
|
+
# http body (model)
|
|
1116
|
+
post_body = nil
|
|
1117
|
+
auth_names = []
|
|
1118
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1119
|
+
:header_params => header_params,
|
|
1120
|
+
:query_params => query_params,
|
|
1121
|
+
:form_params => form_params,
|
|
1122
|
+
:body => post_body,
|
|
1123
|
+
:auth_names => auth_names)
|
|
1124
|
+
if @api_client.config.debugging
|
|
1125
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_brand_resources_by_content_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1126
|
+
end
|
|
1127
|
+
return data, status_code, headers
|
|
1128
|
+
end
|
|
1129
|
+
|
|
1130
|
+
# Gets the Electronic Record and Signature Disclosure.
|
|
1131
|
+
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
|
|
1132
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1133
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
|
1134
|
+
# @return [ConsumerDisclosure]
|
|
1135
|
+
def get_consumer_disclosure(account_id, lang_code)
|
|
1136
|
+
data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
|
|
1137
|
+
return data
|
|
1138
|
+
end
|
|
1139
|
+
|
|
1140
|
+
# Gets the Electronic Record and Signature Disclosure.
|
|
1141
|
+
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
|
|
1142
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1143
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
|
1144
|
+
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
|
1145
|
+
def get_consumer_disclosure_with_http_info(account_id, lang_code)
|
|
1146
|
+
if @api_client.config.debugging
|
|
1147
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_consumer_disclosure ..."
|
|
1148
|
+
end
|
|
1149
|
+
# verify the required parameter 'account_id' is set
|
|
1150
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_consumer_disclosure" if account_id.nil?
|
|
1151
|
+
# verify the required parameter 'lang_code' is set
|
|
1152
|
+
fail ArgumentError, "Missing the required parameter 'lang_code' when calling AccountsApi.get_consumer_disclosure" if lang_code.nil?
|
|
1153
|
+
# resource path
|
|
1154
|
+
local_var_path = "/v2/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s)
|
|
1155
|
+
|
|
1156
|
+
# query parameters
|
|
1157
|
+
query_params = {}
|
|
1158
|
+
|
|
1159
|
+
# header parameters
|
|
1160
|
+
header_params = {}
|
|
1161
|
+
# HTTP header 'Accept' (if needed)
|
|
1162
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1163
|
+
|
|
1164
|
+
# form parameters
|
|
1165
|
+
form_params = {}
|
|
1166
|
+
|
|
1167
|
+
# http body (model)
|
|
1168
|
+
post_body = nil
|
|
1169
|
+
auth_names = []
|
|
1170
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1171
|
+
:header_params => header_params,
|
|
1172
|
+
:query_params => query_params,
|
|
1173
|
+
:form_params => form_params,
|
|
1174
|
+
:body => post_body,
|
|
1175
|
+
:auth_names => auth_names,
|
|
1176
|
+
:return_type => 'ConsumerDisclosure')
|
|
1177
|
+
if @api_client.config.debugging
|
|
1178
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_consumer_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1179
|
+
end
|
|
1180
|
+
return data, status_code, headers
|
|
1181
|
+
end
|
|
1182
|
+
|
|
1183
|
+
# Gets the Electronic Record and Signature Disclosure for the account.
|
|
1184
|
+
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
|
|
1185
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1186
|
+
# @param DocuSign_eSign::GetConsumerDisclosureDefaultOptions Options for modifying the behavior of the function.
|
|
1187
|
+
# @return [ConsumerDisclosure]
|
|
1188
|
+
def get_consumer_disclosure_default(account_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default)
|
|
1189
|
+
data, _status_code, _headers = get_consumer_disclosure_default_with_http_info(account_id, options)
|
|
1190
|
+
return data
|
|
1191
|
+
end
|
|
1192
|
+
|
|
1193
|
+
# Gets the Electronic Record and Signature Disclosure for the account.
|
|
1194
|
+
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
|
|
1195
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1196
|
+
# @param DocuSign_eSign::GetConsumerDisclosureDefaultOptions Options for modifying the behavior of the function.
|
|
1197
|
+
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
|
1198
|
+
def get_consumer_disclosure_default_with_http_info(account_id, options = DocuSign_eSign::GetConsumerDisclosureDefaultOptions.default)
|
|
1199
|
+
if @api_client.config.debugging
|
|
1200
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_consumer_disclosure_default ..."
|
|
1201
|
+
end
|
|
1202
|
+
# verify the required parameter 'account_id' is set
|
|
1203
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_consumer_disclosure_default" if account_id.nil?
|
|
1204
|
+
# resource path
|
|
1205
|
+
local_var_path = "/v2/accounts/{accountId}/consumer_disclosure".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1206
|
+
|
|
1207
|
+
# query parameters
|
|
1208
|
+
query_params = {}
|
|
1209
|
+
query_params[:'langCode'] = options.lang_code if !options.lang_code.nil?
|
|
1210
|
+
|
|
1211
|
+
# header parameters
|
|
1212
|
+
header_params = {}
|
|
1213
|
+
# HTTP header 'Accept' (if needed)
|
|
1214
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1215
|
+
|
|
1216
|
+
# form parameters
|
|
1217
|
+
form_params = {}
|
|
1218
|
+
|
|
1219
|
+
# http body (model)
|
|
1220
|
+
post_body = nil
|
|
1221
|
+
auth_names = []
|
|
1222
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1223
|
+
:header_params => header_params,
|
|
1224
|
+
:query_params => query_params,
|
|
1225
|
+
:form_params => form_params,
|
|
1226
|
+
:body => post_body,
|
|
1227
|
+
:auth_names => auth_names,
|
|
1228
|
+
:return_type => 'ConsumerDisclosure')
|
|
1229
|
+
if @api_client.config.debugging
|
|
1230
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_consumer_disclosure_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1231
|
+
end
|
|
1232
|
+
return data, status_code, headers
|
|
1233
|
+
end
|
|
1234
|
+
|
|
1235
|
+
# Returns the configuration information for the eNote eOriginal integration.
|
|
1236
|
+
#
|
|
1237
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1238
|
+
# @return [ENoteConfiguration]
|
|
1239
|
+
def get_e_note_configuration(account_id)
|
|
1240
|
+
data, _status_code, _headers = get_e_note_configuration_with_http_info(account_id)
|
|
1241
|
+
return data
|
|
1242
|
+
end
|
|
1243
|
+
|
|
1244
|
+
# Returns the configuration information for the eNote eOriginal integration.
|
|
1245
|
+
#
|
|
1246
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1247
|
+
# @return [Array<(ENoteConfiguration, Fixnum, Hash)>] ENoteConfiguration data, response status code and response headers
|
|
1248
|
+
def get_e_note_configuration_with_http_info(account_id)
|
|
1249
|
+
if @api_client.config.debugging
|
|
1250
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_e_note_configuration ..."
|
|
1251
|
+
end
|
|
1252
|
+
# verify the required parameter 'account_id' is set
|
|
1253
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_e_note_configuration" if account_id.nil?
|
|
1254
|
+
# resource path
|
|
1255
|
+
local_var_path = "/v2/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1256
|
+
|
|
1257
|
+
# query parameters
|
|
1258
|
+
query_params = {}
|
|
1259
|
+
|
|
1260
|
+
# header parameters
|
|
1261
|
+
header_params = {}
|
|
1262
|
+
# HTTP header 'Accept' (if needed)
|
|
1263
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1264
|
+
|
|
1265
|
+
# form parameters
|
|
1266
|
+
form_params = {}
|
|
1267
|
+
|
|
1268
|
+
# http body (model)
|
|
1269
|
+
post_body = nil
|
|
1270
|
+
auth_names = []
|
|
1271
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1272
|
+
:header_params => header_params,
|
|
1273
|
+
:query_params => query_params,
|
|
1274
|
+
:form_params => form_params,
|
|
1275
|
+
:body => post_body,
|
|
1276
|
+
:auth_names => auth_names,
|
|
1277
|
+
:return_type => 'ENoteConfiguration')
|
|
1278
|
+
if @api_client.config.debugging
|
|
1279
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_e_note_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1280
|
+
end
|
|
1281
|
+
return data, status_code, headers
|
|
1282
|
+
end
|
|
1283
|
+
|
|
1284
|
+
# Returns a permissions profile in the specified account.
|
|
1285
|
+
#
|
|
1286
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1287
|
+
# @param permission_profile_id
|
|
1288
|
+
# @param DocuSign_eSign::GetPermissionProfileOptions Options for modifying the behavior of the function.
|
|
1289
|
+
# @return [PermissionProfile]
|
|
1290
|
+
def get_permission_profile(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default)
|
|
1291
|
+
data, _status_code, _headers = get_permission_profile_with_http_info(account_id, permission_profile_id, options)
|
|
1292
|
+
return data
|
|
1293
|
+
end
|
|
1294
|
+
|
|
1295
|
+
# Returns a permissions profile in the specified account.
|
|
1296
|
+
#
|
|
1297
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1298
|
+
# @param permission_profile_id
|
|
1299
|
+
# @param DocuSign_eSign::GetPermissionProfileOptions Options for modifying the behavior of the function.
|
|
1300
|
+
# @return [Array<(PermissionProfile, Fixnum, Hash)>] PermissionProfile data, response status code and response headers
|
|
1301
|
+
def get_permission_profile_with_http_info(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default)
|
|
1302
|
+
if @api_client.config.debugging
|
|
1303
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_permission_profile ..."
|
|
1304
|
+
end
|
|
1305
|
+
# verify the required parameter 'account_id' is set
|
|
1306
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_permission_profile" if account_id.nil?
|
|
1307
|
+
# verify the required parameter 'permission_profile_id' is set
|
|
1308
|
+
fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.get_permission_profile" if permission_profile_id.nil?
|
|
1309
|
+
# resource path
|
|
1310
|
+
local_var_path = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)
|
|
1311
|
+
|
|
1312
|
+
# query parameters
|
|
1313
|
+
query_params = {}
|
|
1314
|
+
query_params[:'include'] = options.include if !options.include.nil?
|
|
1315
|
+
|
|
1316
|
+
# header parameters
|
|
1317
|
+
header_params = {}
|
|
1318
|
+
# HTTP header 'Accept' (if needed)
|
|
1319
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1320
|
+
|
|
1321
|
+
# form parameters
|
|
1322
|
+
form_params = {}
|
|
1323
|
+
|
|
1324
|
+
# http body (model)
|
|
1325
|
+
post_body = nil
|
|
1326
|
+
auth_names = []
|
|
1327
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1328
|
+
:header_params => header_params,
|
|
1329
|
+
:query_params => query_params,
|
|
1330
|
+
:form_params => form_params,
|
|
1331
|
+
:body => post_body,
|
|
1332
|
+
:auth_names => auth_names,
|
|
1333
|
+
:return_type => 'PermissionProfile')
|
|
1334
|
+
if @api_client.config.debugging
|
|
1335
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1336
|
+
end
|
|
1337
|
+
return data, status_code, headers
|
|
1338
|
+
end
|
|
1339
|
+
|
|
1340
|
+
# Retrieves the account provisioning information for the account.
|
|
1341
|
+
# Retrieves the account provisioning information for the account.
|
|
1342
|
+
# @return [ProvisioningInformation]
|
|
1343
|
+
def get_provisioning()
|
|
1344
|
+
data, _status_code, _headers = get_provisioning_with_http_info()
|
|
1345
|
+
return data
|
|
1346
|
+
end
|
|
1347
|
+
|
|
1348
|
+
# Retrieves the account provisioning information for the account.
|
|
1349
|
+
# Retrieves the account provisioning information for the account.
|
|
1350
|
+
# @return [Array<(ProvisioningInformation, Fixnum, Hash)>] ProvisioningInformation data, response status code and response headers
|
|
1351
|
+
def get_provisioning_with_http_info()
|
|
1352
|
+
if @api_client.config.debugging
|
|
1353
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_provisioning ..."
|
|
1354
|
+
end
|
|
1355
|
+
# resource path
|
|
1356
|
+
local_var_path = "/v2/accounts/provisioning".sub('{format}','json')
|
|
1357
|
+
|
|
1358
|
+
# query parameters
|
|
1359
|
+
query_params = {}
|
|
1360
|
+
|
|
1361
|
+
# header parameters
|
|
1362
|
+
header_params = {}
|
|
1363
|
+
# HTTP header 'Accept' (if needed)
|
|
1364
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1365
|
+
|
|
1366
|
+
# form parameters
|
|
1367
|
+
form_params = {}
|
|
1368
|
+
|
|
1369
|
+
# http body (model)
|
|
1370
|
+
post_body = nil
|
|
1371
|
+
auth_names = []
|
|
1372
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1373
|
+
:header_params => header_params,
|
|
1374
|
+
:query_params => query_params,
|
|
1375
|
+
:form_params => form_params,
|
|
1376
|
+
:body => post_body,
|
|
1377
|
+
:auth_names => auth_names,
|
|
1378
|
+
:return_type => 'ProvisioningInformation')
|
|
1379
|
+
if @api_client.config.debugging
|
|
1380
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_provisioning\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1381
|
+
end
|
|
1382
|
+
return data, status_code, headers
|
|
1383
|
+
end
|
|
1384
|
+
|
|
1385
|
+
# Gets a list of brand profiles.
|
|
1386
|
+
# Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call.
|
|
1387
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1388
|
+
# @param DocuSign_eSign::ListBrandsOptions Options for modifying the behavior of the function.
|
|
1389
|
+
# @return [BrandsResponse]
|
|
1390
|
+
def list_brands(account_id, options = DocuSign_eSign::ListBrandsOptions.default)
|
|
1391
|
+
data, _status_code, _headers = list_brands_with_http_info(account_id, options)
|
|
1392
|
+
return data
|
|
1393
|
+
end
|
|
1394
|
+
|
|
1395
|
+
# Gets a list of brand profiles.
|
|
1396
|
+
# Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call.
|
|
1397
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1398
|
+
# @param DocuSign_eSign::ListBrandsOptions Options for modifying the behavior of the function.
|
|
1399
|
+
# @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
|
|
1400
|
+
def list_brands_with_http_info(account_id, options = DocuSign_eSign::ListBrandsOptions.default)
|
|
1401
|
+
if @api_client.config.debugging
|
|
1402
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.list_brands ..."
|
|
1403
|
+
end
|
|
1404
|
+
# verify the required parameter 'account_id' is set
|
|
1405
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_brands" if account_id.nil?
|
|
1406
|
+
# resource path
|
|
1407
|
+
local_var_path = "/v2/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1408
|
+
|
|
1409
|
+
# query parameters
|
|
1410
|
+
query_params = {}
|
|
1411
|
+
query_params[:'exclude_distributor_brand'] = options.exclude_distributor_brand if !options.exclude_distributor_brand.nil?
|
|
1412
|
+
query_params[:'include_logos'] = options.include_logos if !options.include_logos.nil?
|
|
1413
|
+
|
|
1414
|
+
# header parameters
|
|
1415
|
+
header_params = {}
|
|
1416
|
+
# HTTP header 'Accept' (if needed)
|
|
1417
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1418
|
+
|
|
1419
|
+
# form parameters
|
|
1420
|
+
form_params = {}
|
|
1421
|
+
|
|
1422
|
+
# http body (model)
|
|
1423
|
+
post_body = nil
|
|
1424
|
+
auth_names = []
|
|
1425
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1426
|
+
:header_params => header_params,
|
|
1427
|
+
:query_params => query_params,
|
|
1428
|
+
:form_params => form_params,
|
|
1429
|
+
:body => post_body,
|
|
1430
|
+
:auth_names => auth_names,
|
|
1431
|
+
:return_type => 'BrandsResponse')
|
|
1432
|
+
if @api_client.config.debugging
|
|
1433
|
+
@api_client.config.logger.debug "API called: AccountsApi#list_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1434
|
+
end
|
|
1435
|
+
return data, status_code, headers
|
|
1436
|
+
end
|
|
1437
|
+
|
|
1438
|
+
# Gets a list of custom fields associated with the account.
|
|
1439
|
+
# Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide.
|
|
1440
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1441
|
+
# @return [CustomFields]
|
|
1442
|
+
def list_custom_fields(account_id)
|
|
1443
|
+
data, _status_code, _headers = list_custom_fields_with_http_info(account_id)
|
|
1444
|
+
return data
|
|
1445
|
+
end
|
|
1446
|
+
|
|
1447
|
+
# Gets a list of custom fields associated with the account.
|
|
1448
|
+
# Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide.
|
|
1449
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1450
|
+
# @return [Array<(CustomFields, Fixnum, Hash)>] CustomFields data, response status code and response headers
|
|
1451
|
+
def list_custom_fields_with_http_info(account_id)
|
|
1452
|
+
if @api_client.config.debugging
|
|
1453
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.list_custom_fields ..."
|
|
1454
|
+
end
|
|
1455
|
+
# verify the required parameter 'account_id' is set
|
|
1456
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_custom_fields" if account_id.nil?
|
|
1457
|
+
# resource path
|
|
1458
|
+
local_var_path = "/v2/accounts/{accountId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1459
|
+
|
|
1460
|
+
# query parameters
|
|
1461
|
+
query_params = {}
|
|
1462
|
+
|
|
1463
|
+
# header parameters
|
|
1464
|
+
header_params = {}
|
|
1465
|
+
# HTTP header 'Accept' (if needed)
|
|
1466
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1467
|
+
|
|
1468
|
+
# form parameters
|
|
1469
|
+
form_params = {}
|
|
1470
|
+
|
|
1471
|
+
# http body (model)
|
|
1472
|
+
post_body = nil
|
|
1473
|
+
auth_names = []
|
|
1474
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1475
|
+
:header_params => header_params,
|
|
1476
|
+
:query_params => query_params,
|
|
1477
|
+
:form_params => form_params,
|
|
1478
|
+
:body => post_body,
|
|
1479
|
+
:auth_names => auth_names,
|
|
1480
|
+
:return_type => 'CustomFields')
|
|
1481
|
+
if @api_client.config.debugging
|
|
1482
|
+
@api_client.config.logger.debug "API called: AccountsApi#list_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1483
|
+
end
|
|
1484
|
+
return data, status_code, headers
|
|
1485
|
+
end
|
|
1486
|
+
|
|
1487
|
+
# Gets a list of permission profiles.
|
|
1488
|
+
# Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console.
|
|
1489
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1490
|
+
# @param DocuSign_eSign::ListPermissionsOptions Options for modifying the behavior of the function.
|
|
1491
|
+
# @return [PermissionProfileInformation]
|
|
1492
|
+
def list_permissions(account_id, options = DocuSign_eSign::ListPermissionsOptions.default)
|
|
1493
|
+
data, _status_code, _headers = list_permissions_with_http_info(account_id, options)
|
|
1494
|
+
return data
|
|
1495
|
+
end
|
|
1496
|
+
|
|
1497
|
+
# Gets a list of permission profiles.
|
|
1498
|
+
# Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console.
|
|
1499
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1500
|
+
# @param DocuSign_eSign::ListPermissionsOptions Options for modifying the behavior of the function.
|
|
1501
|
+
# @return [Array<(PermissionProfileInformation, Fixnum, Hash)>] PermissionProfileInformation data, response status code and response headers
|
|
1502
|
+
def list_permissions_with_http_info(account_id, options = DocuSign_eSign::ListPermissionsOptions.default)
|
|
1503
|
+
if @api_client.config.debugging
|
|
1504
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.list_permissions ..."
|
|
1505
|
+
end
|
|
1506
|
+
# verify the required parameter 'account_id' is set
|
|
1507
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_permissions" if account_id.nil?
|
|
1508
|
+
# resource path
|
|
1509
|
+
local_var_path = "/v2/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1510
|
+
|
|
1511
|
+
# query parameters
|
|
1512
|
+
query_params = {}
|
|
1513
|
+
query_params[:'include'] = options.include if !options.include.nil?
|
|
1514
|
+
|
|
1515
|
+
# header parameters
|
|
1516
|
+
header_params = {}
|
|
1517
|
+
# HTTP header 'Accept' (if needed)
|
|
1518
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1519
|
+
|
|
1520
|
+
# form parameters
|
|
1521
|
+
form_params = {}
|
|
1522
|
+
|
|
1523
|
+
# http body (model)
|
|
1524
|
+
post_body = nil
|
|
1525
|
+
auth_names = []
|
|
1526
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1527
|
+
:header_params => header_params,
|
|
1528
|
+
:query_params => query_params,
|
|
1529
|
+
:form_params => form_params,
|
|
1530
|
+
:body => post_body,
|
|
1531
|
+
:auth_names => auth_names,
|
|
1532
|
+
:return_type => 'PermissionProfileInformation')
|
|
1533
|
+
if @api_client.config.debugging
|
|
1534
|
+
@api_client.config.logger.debug "API called: AccountsApi#list_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1535
|
+
end
|
|
1536
|
+
return data, status_code, headers
|
|
1537
|
+
end
|
|
1538
|
+
|
|
1539
|
+
# Gets recipient names associated with an email address.
|
|
1540
|
+
# Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.
|
|
1541
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1542
|
+
# @param DocuSign_eSign::ListRecipientNamesByEmailOptions Options for modifying the behavior of the function.
|
|
1543
|
+
# @return [RecipientNamesResponse]
|
|
1544
|
+
def list_recipient_names_by_email(account_id, options = DocuSign_eSign::ListRecipientNamesByEmailOptions.default)
|
|
1545
|
+
data, _status_code, _headers = list_recipient_names_by_email_with_http_info(account_id, options)
|
|
1546
|
+
return data
|
|
1547
|
+
end
|
|
1548
|
+
|
|
1549
|
+
# Gets recipient names associated with an email address.
|
|
1550
|
+
# Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.
|
|
1551
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1552
|
+
# @param DocuSign_eSign::ListRecipientNamesByEmailOptions Options for modifying the behavior of the function.
|
|
1553
|
+
# @return [Array<(RecipientNamesResponse, Fixnum, Hash)>] RecipientNamesResponse data, response status code and response headers
|
|
1554
|
+
def list_recipient_names_by_email_with_http_info(account_id, options = DocuSign_eSign::ListRecipientNamesByEmailOptions.default)
|
|
1555
|
+
if @api_client.config.debugging
|
|
1556
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.list_recipient_names_by_email ..."
|
|
1557
|
+
end
|
|
1558
|
+
# verify the required parameter 'account_id' is set
|
|
1559
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_recipient_names_by_email" if account_id.nil?
|
|
1560
|
+
# resource path
|
|
1561
|
+
local_var_path = "/v2/accounts/{accountId}/recipient_names".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1562
|
+
|
|
1563
|
+
# query parameters
|
|
1564
|
+
query_params = {}
|
|
1565
|
+
query_params[:'email'] = options.email if !options.email.nil?
|
|
1566
|
+
|
|
1567
|
+
# header parameters
|
|
1568
|
+
header_params = {}
|
|
1569
|
+
# HTTP header 'Accept' (if needed)
|
|
1570
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1571
|
+
|
|
1572
|
+
# form parameters
|
|
1573
|
+
form_params = {}
|
|
1574
|
+
|
|
1575
|
+
# http body (model)
|
|
1576
|
+
post_body = nil
|
|
1577
|
+
auth_names = []
|
|
1578
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1579
|
+
:header_params => header_params,
|
|
1580
|
+
:query_params => query_params,
|
|
1581
|
+
:form_params => form_params,
|
|
1582
|
+
:body => post_body,
|
|
1583
|
+
:auth_names => auth_names,
|
|
1584
|
+
:return_type => 'RecipientNamesResponse')
|
|
1585
|
+
if @api_client.config.debugging
|
|
1586
|
+
@api_client.config.logger.debug "API called: AccountsApi#list_recipient_names_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1587
|
+
end
|
|
1588
|
+
return data, status_code, headers
|
|
1589
|
+
end
|
|
1590
|
+
|
|
1591
|
+
# Gets account settings information.
|
|
1592
|
+
# Retrieves the account settings information for the specified account.
|
|
1593
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1594
|
+
# @return [AccountSettingsInformation]
|
|
1595
|
+
def list_settings(account_id)
|
|
1596
|
+
data, _status_code, _headers = list_settings_with_http_info(account_id)
|
|
1597
|
+
return data
|
|
1598
|
+
end
|
|
1599
|
+
|
|
1600
|
+
# Gets account settings information.
|
|
1601
|
+
# Retrieves the account settings information for the specified account.
|
|
1602
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1603
|
+
# @return [Array<(AccountSettingsInformation, Fixnum, Hash)>] AccountSettingsInformation data, response status code and response headers
|
|
1604
|
+
def list_settings_with_http_info(account_id)
|
|
1605
|
+
if @api_client.config.debugging
|
|
1606
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.list_settings ..."
|
|
1607
|
+
end
|
|
1608
|
+
# verify the required parameter 'account_id' is set
|
|
1609
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_settings" if account_id.nil?
|
|
1610
|
+
# resource path
|
|
1611
|
+
local_var_path = "/v2/accounts/{accountId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1612
|
+
|
|
1613
|
+
# query parameters
|
|
1614
|
+
query_params = {}
|
|
1615
|
+
|
|
1616
|
+
# header parameters
|
|
1617
|
+
header_params = {}
|
|
1618
|
+
# HTTP header 'Accept' (if needed)
|
|
1619
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1620
|
+
|
|
1621
|
+
# form parameters
|
|
1622
|
+
form_params = {}
|
|
1623
|
+
|
|
1624
|
+
# http body (model)
|
|
1625
|
+
post_body = nil
|
|
1626
|
+
auth_names = []
|
|
1627
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1628
|
+
:header_params => header_params,
|
|
1629
|
+
:query_params => query_params,
|
|
1630
|
+
:form_params => form_params,
|
|
1631
|
+
:body => post_body,
|
|
1632
|
+
:auth_names => auth_names,
|
|
1633
|
+
:return_type => 'AccountSettingsInformation')
|
|
1634
|
+
if @api_client.config.debugging
|
|
1635
|
+
@api_client.config.logger.debug "API called: AccountsApi#list_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1636
|
+
end
|
|
1637
|
+
return data, status_code, headers
|
|
1638
|
+
end
|
|
1639
|
+
|
|
1640
|
+
# Reserved: Gets the shared item status for one or more users.
|
|
1641
|
+
# Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from.
|
|
1642
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1643
|
+
# @param DocuSign_eSign::ListSharedAccessOptions Options for modifying the behavior of the function.
|
|
1644
|
+
# @return [AccountSharedAccess]
|
|
1645
|
+
def list_shared_access(account_id, options = DocuSign_eSign::ListSharedAccessOptions.default)
|
|
1646
|
+
data, _status_code, _headers = list_shared_access_with_http_info(account_id, options)
|
|
1647
|
+
return data
|
|
1648
|
+
end
|
|
1649
|
+
|
|
1650
|
+
# Reserved: Gets the shared item status for one or more users.
|
|
1651
|
+
# Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from.
|
|
1652
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1653
|
+
# @param DocuSign_eSign::ListSharedAccessOptions Options for modifying the behavior of the function.
|
|
1654
|
+
# @return [Array<(AccountSharedAccess, Fixnum, Hash)>] AccountSharedAccess data, response status code and response headers
|
|
1655
|
+
def list_shared_access_with_http_info(account_id, options = DocuSign_eSign::ListSharedAccessOptions.default)
|
|
1656
|
+
if @api_client.config.debugging
|
|
1657
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.list_shared_access ..."
|
|
1658
|
+
end
|
|
1659
|
+
# verify the required parameter 'account_id' is set
|
|
1660
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_shared_access" if account_id.nil?
|
|
1661
|
+
# resource path
|
|
1662
|
+
local_var_path = "/v2/accounts/{accountId}/shared_access".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1663
|
+
|
|
1664
|
+
# query parameters
|
|
1665
|
+
query_params = {}
|
|
1666
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
|
1667
|
+
query_params[:'envelopes_not_shared_user_status'] = options.envelopes_not_shared_user_status if !options.envelopes_not_shared_user_status.nil?
|
|
1668
|
+
query_params[:'folder_ids'] = options.folder_ids if !options.folder_ids.nil?
|
|
1669
|
+
query_params[:'item_type'] = options.item_type if !options.item_type.nil?
|
|
1670
|
+
query_params[:'search_text'] = options.search_text if !options.search_text.nil?
|
|
1671
|
+
query_params[:'shared'] = options.shared if !options.shared.nil?
|
|
1672
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
|
1673
|
+
query_params[:'user_ids'] = options.user_ids if !options.user_ids.nil?
|
|
1674
|
+
|
|
1675
|
+
# header parameters
|
|
1676
|
+
header_params = {}
|
|
1677
|
+
# HTTP header 'Accept' (if needed)
|
|
1678
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1679
|
+
|
|
1680
|
+
# form parameters
|
|
1681
|
+
form_params = {}
|
|
1682
|
+
|
|
1683
|
+
# http body (model)
|
|
1684
|
+
post_body = nil
|
|
1685
|
+
auth_names = []
|
|
1686
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1687
|
+
:header_params => header_params,
|
|
1688
|
+
:query_params => query_params,
|
|
1689
|
+
:form_params => form_params,
|
|
1690
|
+
:body => post_body,
|
|
1691
|
+
:auth_names => auth_names,
|
|
1692
|
+
:return_type => 'AccountSharedAccess')
|
|
1693
|
+
if @api_client.config.debugging
|
|
1694
|
+
@api_client.config.logger.debug "API called: AccountsApi#list_shared_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1695
|
+
end
|
|
1696
|
+
return data, status_code, headers
|
|
1697
|
+
end
|
|
1698
|
+
|
|
1699
|
+
# Returns Account available signature providers for specified account.
|
|
1700
|
+
#
|
|
1701
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1702
|
+
# @return [AccountSignatureProviders]
|
|
1703
|
+
def list_signature_providers(account_id)
|
|
1704
|
+
data, _status_code, _headers = list_signature_providers_with_http_info(account_id)
|
|
1705
|
+
return data
|
|
1706
|
+
end
|
|
1707
|
+
|
|
1708
|
+
# Returns Account available signature providers for specified account.
|
|
1709
|
+
#
|
|
1710
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1711
|
+
# @return [Array<(AccountSignatureProviders, Fixnum, Hash)>] AccountSignatureProviders data, response status code and response headers
|
|
1712
|
+
def list_signature_providers_with_http_info(account_id)
|
|
1713
|
+
if @api_client.config.debugging
|
|
1714
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.list_signature_providers ..."
|
|
1715
|
+
end
|
|
1716
|
+
# verify the required parameter 'account_id' is set
|
|
1717
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_signature_providers" if account_id.nil?
|
|
1718
|
+
# resource path
|
|
1719
|
+
local_var_path = "/v2/accounts/{accountId}/signatureProviders".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1720
|
+
|
|
1721
|
+
# query parameters
|
|
1722
|
+
query_params = {}
|
|
1723
|
+
|
|
1724
|
+
# header parameters
|
|
1725
|
+
header_params = {}
|
|
1726
|
+
# HTTP header 'Accept' (if needed)
|
|
1727
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1728
|
+
|
|
1729
|
+
# form parameters
|
|
1730
|
+
form_params = {}
|
|
1731
|
+
|
|
1732
|
+
# http body (model)
|
|
1733
|
+
post_body = nil
|
|
1734
|
+
auth_names = []
|
|
1735
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1736
|
+
:header_params => header_params,
|
|
1737
|
+
:query_params => query_params,
|
|
1738
|
+
:form_params => form_params,
|
|
1739
|
+
:body => post_body,
|
|
1740
|
+
:auth_names => auth_names,
|
|
1741
|
+
:return_type => 'AccountSignatureProviders')
|
|
1742
|
+
if @api_client.config.debugging
|
|
1743
|
+
@api_client.config.logger.debug "API called: AccountsApi#list_signature_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1744
|
+
end
|
|
1745
|
+
return data, status_code, headers
|
|
1746
|
+
end
|
|
1747
|
+
|
|
1748
|
+
# Gets a list of unsupported file types.
|
|
1749
|
+
# Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.
|
|
1750
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1751
|
+
# @return [FileTypeList]
|
|
1752
|
+
def list_unsupported_file_types(account_id)
|
|
1753
|
+
data, _status_code, _headers = list_unsupported_file_types_with_http_info(account_id)
|
|
1754
|
+
return data
|
|
1755
|
+
end
|
|
1756
|
+
|
|
1757
|
+
# Gets a list of unsupported file types.
|
|
1758
|
+
# Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.
|
|
1759
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1760
|
+
# @return [Array<(FileTypeList, Fixnum, Hash)>] FileTypeList data, response status code and response headers
|
|
1761
|
+
def list_unsupported_file_types_with_http_info(account_id)
|
|
1762
|
+
if @api_client.config.debugging
|
|
1763
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.list_unsupported_file_types ..."
|
|
1764
|
+
end
|
|
1765
|
+
# verify the required parameter 'account_id' is set
|
|
1766
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_unsupported_file_types" if account_id.nil?
|
|
1767
|
+
# resource path
|
|
1768
|
+
local_var_path = "/v2/accounts/{accountId}/unsupported_file_types".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1769
|
+
|
|
1770
|
+
# query parameters
|
|
1771
|
+
query_params = {}
|
|
1772
|
+
|
|
1773
|
+
# header parameters
|
|
1774
|
+
header_params = {}
|
|
1775
|
+
# HTTP header 'Accept' (if needed)
|
|
1776
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1777
|
+
|
|
1778
|
+
# form parameters
|
|
1779
|
+
form_params = {}
|
|
1780
|
+
|
|
1781
|
+
# http body (model)
|
|
1782
|
+
post_body = nil
|
|
1783
|
+
auth_names = []
|
|
1784
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1785
|
+
:header_params => header_params,
|
|
1786
|
+
:query_params => query_params,
|
|
1787
|
+
:form_params => form_params,
|
|
1788
|
+
:body => post_body,
|
|
1789
|
+
:auth_names => auth_names,
|
|
1790
|
+
:return_type => 'FileTypeList')
|
|
1791
|
+
if @api_client.config.debugging
|
|
1792
|
+
@api_client.config.logger.debug "API called: AccountsApi#list_unsupported_file_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1793
|
+
end
|
|
1794
|
+
return data, status_code, headers
|
|
1795
|
+
end
|
|
1796
|
+
|
|
1797
|
+
# Modifies tab settings for specified account
|
|
1798
|
+
#
|
|
1799
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1800
|
+
# @param tab_account_settings (optional parameter)
|
|
1801
|
+
# @return [TabAccountSettings]
|
|
1802
|
+
def update_account_tab_settings(account_id, tab_account_settings)
|
|
1803
|
+
data, _status_code, _headers = update_account_tab_settings_with_http_info(account_id, tab_account_settings)
|
|
1804
|
+
return data
|
|
1805
|
+
end
|
|
1806
|
+
|
|
1807
|
+
# Modifies tab settings for specified account
|
|
1808
|
+
#
|
|
1809
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1810
|
+
# @param tab_account_settings (optional parameter)
|
|
1811
|
+
# @return [Array<(TabAccountSettings, Fixnum, Hash)>] TabAccountSettings data, response status code and response headers
|
|
1812
|
+
def update_account_tab_settings_with_http_info(account_id, tab_account_settings)
|
|
1813
|
+
if @api_client.config.debugging
|
|
1814
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_account_tab_settings ..."
|
|
1815
|
+
end
|
|
1816
|
+
# verify the required parameter 'account_id' is set
|
|
1817
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_tab_settings" if account_id.nil?
|
|
1818
|
+
# resource path
|
|
1819
|
+
local_var_path = "/v2/accounts/{accountId}/settings/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
1820
|
+
|
|
1821
|
+
# query parameters
|
|
1822
|
+
query_params = {}
|
|
1823
|
+
|
|
1824
|
+
# header parameters
|
|
1825
|
+
header_params = {}
|
|
1826
|
+
# HTTP header 'Accept' (if needed)
|
|
1827
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1828
|
+
|
|
1829
|
+
# form parameters
|
|
1830
|
+
form_params = {}
|
|
1831
|
+
|
|
1832
|
+
# http body (model)
|
|
1833
|
+
post_body = @api_client.object_to_http_body(tab_account_settings)
|
|
1834
|
+
auth_names = []
|
|
1835
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1836
|
+
:header_params => header_params,
|
|
1837
|
+
:query_params => query_params,
|
|
1838
|
+
:form_params => form_params,
|
|
1839
|
+
:body => post_body,
|
|
1840
|
+
:auth_names => auth_names,
|
|
1841
|
+
:return_type => 'TabAccountSettings')
|
|
1842
|
+
if @api_client.config.debugging
|
|
1843
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_account_tab_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1844
|
+
end
|
|
1845
|
+
return data, status_code, headers
|
|
1846
|
+
end
|
|
1847
|
+
|
|
1848
|
+
# Updates an existing brand.
|
|
1849
|
+
#
|
|
1850
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1851
|
+
# @param brand_id The unique identifier of a brand.
|
|
1852
|
+
# @param brand (optional parameter)
|
|
1853
|
+
# @return [Brand]
|
|
1854
|
+
def update_brand(account_id, brand_id, brand)
|
|
1855
|
+
data, _status_code, _headers = update_brand_with_http_info(account_id, brand_id, brand)
|
|
1856
|
+
return data
|
|
1857
|
+
end
|
|
1858
|
+
|
|
1859
|
+
# Updates an existing brand.
|
|
1860
|
+
#
|
|
1861
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1862
|
+
# @param brand_id The unique identifier of a brand.
|
|
1863
|
+
# @param brand (optional parameter)
|
|
1864
|
+
# @return [Array<(Brand, Fixnum, Hash)>] Brand data, response status code and response headers
|
|
1865
|
+
def update_brand_with_http_info(account_id, brand_id, brand)
|
|
1866
|
+
if @api_client.config.debugging
|
|
1867
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_brand ..."
|
|
1868
|
+
end
|
|
1869
|
+
# verify the required parameter 'account_id' is set
|
|
1870
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_brand" if account_id.nil?
|
|
1871
|
+
# verify the required parameter 'brand_id' is set
|
|
1872
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand" if brand_id.nil?
|
|
1873
|
+
# resource path
|
|
1874
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
|
1875
|
+
|
|
1876
|
+
# query parameters
|
|
1877
|
+
query_params = {}
|
|
1878
|
+
|
|
1879
|
+
# header parameters
|
|
1880
|
+
header_params = {}
|
|
1881
|
+
# HTTP header 'Accept' (if needed)
|
|
1882
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1883
|
+
|
|
1884
|
+
# form parameters
|
|
1885
|
+
form_params = {}
|
|
1886
|
+
|
|
1887
|
+
# http body (model)
|
|
1888
|
+
post_body = @api_client.object_to_http_body(brand)
|
|
1889
|
+
auth_names = []
|
|
1890
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1891
|
+
:header_params => header_params,
|
|
1892
|
+
:query_params => query_params,
|
|
1893
|
+
:form_params => form_params,
|
|
1894
|
+
:body => post_body,
|
|
1895
|
+
:auth_names => auth_names,
|
|
1896
|
+
:return_type => 'Brand')
|
|
1897
|
+
if @api_client.config.debugging
|
|
1898
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1899
|
+
end
|
|
1900
|
+
return data, status_code, headers
|
|
1901
|
+
end
|
|
1902
|
+
|
|
1903
|
+
# Put one branding logo.
|
|
1904
|
+
#
|
|
1905
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1906
|
+
# @param brand_id The unique identifier of a brand.
|
|
1907
|
+
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
|
1908
|
+
# @return [nil]
|
|
1909
|
+
def update_brand_logo_by_type(account_id, brand_id, logo_type)
|
|
1910
|
+
update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
|
1911
|
+
return nil
|
|
1912
|
+
end
|
|
1913
|
+
|
|
1914
|
+
# Put one branding logo.
|
|
1915
|
+
#
|
|
1916
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1917
|
+
# @param brand_id The unique identifier of a brand.
|
|
1918
|
+
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
|
1919
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1920
|
+
def update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
|
1921
|
+
if @api_client.config.debugging
|
|
1922
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_brand_logo_by_type ..."
|
|
1923
|
+
end
|
|
1924
|
+
# verify the required parameter 'account_id' is set
|
|
1925
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_brand_logo_by_type" if account_id.nil?
|
|
1926
|
+
# verify the required parameter 'brand_id' is set
|
|
1927
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_logo_by_type" if brand_id.nil?
|
|
1928
|
+
# verify the required parameter 'logo_type' is set
|
|
1929
|
+
fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.update_brand_logo_by_type" if logo_type.nil?
|
|
1930
|
+
# resource path
|
|
1931
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)
|
|
1932
|
+
|
|
1933
|
+
# query parameters
|
|
1934
|
+
query_params = {}
|
|
1935
|
+
|
|
1936
|
+
# header parameters
|
|
1937
|
+
header_params = {}
|
|
1938
|
+
# HTTP header 'Accept' (if needed)
|
|
1939
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1940
|
+
|
|
1941
|
+
# form parameters
|
|
1942
|
+
form_params = {}
|
|
1943
|
+
|
|
1944
|
+
# http body (model)
|
|
1945
|
+
post_body = nil
|
|
1946
|
+
auth_names = []
|
|
1947
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1948
|
+
:header_params => header_params,
|
|
1949
|
+
:query_params => query_params,
|
|
1950
|
+
:form_params => form_params,
|
|
1951
|
+
:body => post_body,
|
|
1952
|
+
:auth_names => auth_names)
|
|
1953
|
+
if @api_client.config.debugging
|
|
1954
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1955
|
+
end
|
|
1956
|
+
return data, status_code, headers
|
|
1957
|
+
end
|
|
1958
|
+
|
|
1959
|
+
# Uploads a branding resource file.
|
|
1960
|
+
#
|
|
1961
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1962
|
+
# @param brand_id The unique identifier of a brand.
|
|
1963
|
+
# @param resource_content_type
|
|
1964
|
+
# @return [BrandResources]
|
|
1965
|
+
def update_brand_resources_by_content_type(account_id, brand_id, resource_content_type)
|
|
1966
|
+
data, _status_code, _headers = update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
|
|
1967
|
+
return data
|
|
1968
|
+
end
|
|
1969
|
+
|
|
1970
|
+
# Uploads a branding resource file.
|
|
1971
|
+
#
|
|
1972
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
1973
|
+
# @param brand_id The unique identifier of a brand.
|
|
1974
|
+
# @param resource_content_type
|
|
1975
|
+
# @return [Array<(BrandResources, Fixnum, Hash)>] BrandResources data, response status code and response headers
|
|
1976
|
+
def update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
|
|
1977
|
+
if @api_client.config.debugging
|
|
1978
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_brand_resources_by_content_type ..."
|
|
1979
|
+
end
|
|
1980
|
+
# verify the required parameter 'account_id' is set
|
|
1981
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_brand_resources_by_content_type" if account_id.nil?
|
|
1982
|
+
# verify the required parameter 'brand_id' is set
|
|
1983
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_resources_by_content_type" if brand_id.nil?
|
|
1984
|
+
# verify the required parameter 'resource_content_type' is set
|
|
1985
|
+
fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.update_brand_resources_by_content_type" if resource_content_type.nil?
|
|
1986
|
+
# resource path
|
|
1987
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)
|
|
1988
|
+
|
|
1989
|
+
# query parameters
|
|
1990
|
+
query_params = {}
|
|
1991
|
+
|
|
1992
|
+
# header parameters
|
|
1993
|
+
header_params = {}
|
|
1994
|
+
# HTTP header 'Accept' (if needed)
|
|
1995
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1996
|
+
|
|
1997
|
+
# form parameters
|
|
1998
|
+
form_params = {}
|
|
1999
|
+
|
|
2000
|
+
# http body (model)
|
|
2001
|
+
post_body = nil
|
|
2002
|
+
auth_names = []
|
|
2003
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
2004
|
+
:header_params => header_params,
|
|
2005
|
+
:query_params => query_params,
|
|
2006
|
+
:form_params => form_params,
|
|
2007
|
+
:body => post_body,
|
|
2008
|
+
:auth_names => auth_names,
|
|
2009
|
+
:return_type => 'BrandResources')
|
|
2010
|
+
if @api_client.config.debugging
|
|
2011
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_brand_resources_by_content_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2012
|
+
end
|
|
2013
|
+
return data, status_code, headers
|
|
2014
|
+
end
|
|
2015
|
+
|
|
2016
|
+
# Updates configuration information for the eNote eOriginal integration.
|
|
2017
|
+
#
|
|
2018
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
2019
|
+
# @param e_note_configuration (optional parameter)
|
|
2020
|
+
# @return [ENoteConfiguration]
|
|
2021
|
+
def update_e_note_configuration(account_id, e_note_configuration)
|
|
2022
|
+
data, _status_code, _headers = update_e_note_configuration_with_http_info(account_id, e_note_configuration)
|
|
2023
|
+
return data
|
|
2024
|
+
end
|
|
2025
|
+
|
|
2026
|
+
# Updates configuration information for the eNote eOriginal integration.
|
|
2027
|
+
#
|
|
2028
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
2029
|
+
# @param e_note_configuration (optional parameter)
|
|
2030
|
+
# @return [Array<(ENoteConfiguration, Fixnum, Hash)>] ENoteConfiguration data, response status code and response headers
|
|
2031
|
+
def update_e_note_configuration_with_http_info(account_id, e_note_configuration)
|
|
2032
|
+
if @api_client.config.debugging
|
|
2033
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_e_note_configuration ..."
|
|
2034
|
+
end
|
|
2035
|
+
# verify the required parameter 'account_id' is set
|
|
2036
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_e_note_configuration" if account_id.nil?
|
|
2037
|
+
# resource path
|
|
2038
|
+
local_var_path = "/v2/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
2039
|
+
|
|
2040
|
+
# query parameters
|
|
2041
|
+
query_params = {}
|
|
2042
|
+
|
|
2043
|
+
# header parameters
|
|
2044
|
+
header_params = {}
|
|
2045
|
+
# HTTP header 'Accept' (if needed)
|
|
2046
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2047
|
+
|
|
2048
|
+
# form parameters
|
|
2049
|
+
form_params = {}
|
|
2050
|
+
|
|
2051
|
+
# http body (model)
|
|
2052
|
+
post_body = @api_client.object_to_http_body(e_note_configuration)
|
|
2053
|
+
auth_names = []
|
|
2054
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
2055
|
+
:header_params => header_params,
|
|
2056
|
+
:query_params => query_params,
|
|
2057
|
+
:form_params => form_params,
|
|
2058
|
+
:body => post_body,
|
|
2059
|
+
:auth_names => auth_names,
|
|
2060
|
+
:return_type => 'ENoteConfiguration')
|
|
2061
|
+
if @api_client.config.debugging
|
|
2062
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_e_note_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2063
|
+
end
|
|
2064
|
+
return data, status_code, headers
|
|
2065
|
+
end
|
|
2066
|
+
|
|
2067
|
+
# Updates a permission profile within the specified account.
|
|
2068
|
+
#
|
|
2069
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
2070
|
+
# @param permission_profile_id
|
|
2071
|
+
# @param permission_profile (optional parameter)
|
|
2072
|
+
# @param DocuSign_eSign::UpdatePermissionProfileOptions Options for modifying the behavior of the function.
|
|
2073
|
+
# @return [PermissionProfile]
|
|
2074
|
+
def update_permission_profile(account_id, permission_profile_id, permission_profile, options = DocuSign_eSign::UpdatePermissionProfileOptions.default)
|
|
2075
|
+
data, _status_code, _headers = update_permission_profile_with_http_info(account_id, permission_profile_id, permission_profile, options)
|
|
2076
|
+
return data
|
|
2077
|
+
end
|
|
2078
|
+
|
|
2079
|
+
# Updates a permission profile within the specified account.
|
|
2080
|
+
#
|
|
2081
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
2082
|
+
# @param permission_profile_id
|
|
2083
|
+
# @param permission_profile (optional parameter)
|
|
2084
|
+
# @param DocuSign_eSign::UpdatePermissionProfileOptions Options for modifying the behavior of the function.
|
|
2085
|
+
# @return [Array<(PermissionProfile, Fixnum, Hash)>] PermissionProfile data, response status code and response headers
|
|
2086
|
+
def update_permission_profile_with_http_info(account_id, permission_profile_id, permission_profile, options = DocuSign_eSign::UpdatePermissionProfileOptions.default)
|
|
2087
|
+
if @api_client.config.debugging
|
|
2088
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_permission_profile ..."
|
|
2089
|
+
end
|
|
2090
|
+
# verify the required parameter 'account_id' is set
|
|
2091
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_permission_profile" if account_id.nil?
|
|
2092
|
+
# verify the required parameter 'permission_profile_id' is set
|
|
2093
|
+
fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.update_permission_profile" if permission_profile_id.nil?
|
|
2094
|
+
# resource path
|
|
2095
|
+
local_var_path = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)
|
|
2096
|
+
|
|
2097
|
+
# query parameters
|
|
2098
|
+
query_params = {}
|
|
2099
|
+
query_params[:'include'] = options.include if !options.include.nil?
|
|
2100
|
+
|
|
2101
|
+
# header parameters
|
|
2102
|
+
header_params = {}
|
|
2103
|
+
# HTTP header 'Accept' (if needed)
|
|
2104
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2105
|
+
|
|
2106
|
+
# form parameters
|
|
2107
|
+
form_params = {}
|
|
2108
|
+
|
|
2109
|
+
# http body (model)
|
|
2110
|
+
post_body = @api_client.object_to_http_body(permission_profile)
|
|
2111
|
+
auth_names = []
|
|
2112
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
2113
|
+
:header_params => header_params,
|
|
2114
|
+
:query_params => query_params,
|
|
2115
|
+
:form_params => form_params,
|
|
2116
|
+
:body => post_body,
|
|
2117
|
+
:auth_names => auth_names,
|
|
2118
|
+
:return_type => 'PermissionProfile')
|
|
2119
|
+
if @api_client.config.debugging
|
|
2120
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2121
|
+
end
|
|
2122
|
+
return data, status_code, headers
|
|
2123
|
+
end
|
|
2124
|
+
|
|
2125
|
+
# Updates the account settings for an account.
|
|
2126
|
+
# Updates the account settings for the specified account.
|
|
2127
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
2128
|
+
# @param account_settings_information (optional parameter)
|
|
2129
|
+
# @return [nil]
|
|
2130
|
+
def update_settings(account_id, account_settings_information)
|
|
2131
|
+
update_settings_with_http_info(account_id, account_settings_information)
|
|
2132
|
+
return nil
|
|
2133
|
+
end
|
|
2134
|
+
|
|
2135
|
+
# Updates the account settings for an account.
|
|
2136
|
+
# Updates the account settings for the specified account.
|
|
2137
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
2138
|
+
# @param account_settings_information (optional parameter)
|
|
2139
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
2140
|
+
def update_settings_with_http_info(account_id, account_settings_information)
|
|
2141
|
+
if @api_client.config.debugging
|
|
2142
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_settings ..."
|
|
2143
|
+
end
|
|
2144
|
+
# verify the required parameter 'account_id' is set
|
|
2145
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_settings" if account_id.nil?
|
|
2146
|
+
# resource path
|
|
2147
|
+
local_var_path = "/v2/accounts/{accountId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
2148
|
+
|
|
2149
|
+
# query parameters
|
|
2150
|
+
query_params = {}
|
|
2151
|
+
|
|
2152
|
+
# header parameters
|
|
2153
|
+
header_params = {}
|
|
2154
|
+
# HTTP header 'Accept' (if needed)
|
|
2155
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2156
|
+
|
|
2157
|
+
# form parameters
|
|
2158
|
+
form_params = {}
|
|
2159
|
+
|
|
2160
|
+
# http body (model)
|
|
2161
|
+
post_body = @api_client.object_to_http_body(account_settings_information)
|
|
2162
|
+
auth_names = []
|
|
2163
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
2164
|
+
:header_params => header_params,
|
|
2165
|
+
:query_params => query_params,
|
|
2166
|
+
:form_params => form_params,
|
|
2167
|
+
:body => post_body,
|
|
2168
|
+
:auth_names => auth_names)
|
|
2169
|
+
if @api_client.config.debugging
|
|
2170
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2171
|
+
end
|
|
2172
|
+
return data, status_code, headers
|
|
2173
|
+
end
|
|
2174
|
+
|
|
2175
|
+
# Reserved: Sets the shared access information for users.
|
|
2176
|
+
# Reserved: Sets the shared access information for one or more users.
|
|
2177
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
2178
|
+
# @param account_shared_access (optional parameter)
|
|
2179
|
+
# @param DocuSign_eSign::UpdateSharedAccessOptions Options for modifying the behavior of the function.
|
|
2180
|
+
# @return [AccountSharedAccess]
|
|
2181
|
+
def update_shared_access(account_id, account_shared_access, options = DocuSign_eSign::UpdateSharedAccessOptions.default)
|
|
2182
|
+
data, _status_code, _headers = update_shared_access_with_http_info(account_id, account_shared_access, options)
|
|
2183
|
+
return data
|
|
2184
|
+
end
|
|
2185
|
+
|
|
2186
|
+
# Reserved: Sets the shared access information for users.
|
|
2187
|
+
# Reserved: Sets the shared access information for one or more users.
|
|
2188
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
2189
|
+
# @param account_shared_access (optional parameter)
|
|
2190
|
+
# @param DocuSign_eSign::UpdateSharedAccessOptions Options for modifying the behavior of the function.
|
|
2191
|
+
# @return [Array<(AccountSharedAccess, Fixnum, Hash)>] AccountSharedAccess data, response status code and response headers
|
|
2192
|
+
def update_shared_access_with_http_info(account_id, account_shared_access, options = DocuSign_eSign::UpdateSharedAccessOptions.default)
|
|
2193
|
+
if @api_client.config.debugging
|
|
2194
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_shared_access ..."
|
|
2195
|
+
end
|
|
2196
|
+
# verify the required parameter 'account_id' is set
|
|
2197
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_shared_access" if account_id.nil?
|
|
2198
|
+
# resource path
|
|
2199
|
+
local_var_path = "/v2/accounts/{accountId}/shared_access".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
2200
|
+
|
|
2201
|
+
# query parameters
|
|
2202
|
+
query_params = {}
|
|
2203
|
+
query_params[:'item_type'] = options.item_type if !options.item_type.nil?
|
|
2204
|
+
query_params[:'user_ids'] = options.user_ids if !options.user_ids.nil?
|
|
2205
|
+
|
|
2206
|
+
# header parameters
|
|
2207
|
+
header_params = {}
|
|
2208
|
+
# HTTP header 'Accept' (if needed)
|
|
2209
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2210
|
+
|
|
2211
|
+
# form parameters
|
|
2212
|
+
form_params = {}
|
|
2213
|
+
|
|
2214
|
+
# http body (model)
|
|
2215
|
+
post_body = @api_client.object_to_http_body(account_shared_access)
|
|
2216
|
+
auth_names = []
|
|
2217
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
2218
|
+
:header_params => header_params,
|
|
2219
|
+
:query_params => query_params,
|
|
2220
|
+
:form_params => form_params,
|
|
2221
|
+
:body => post_body,
|
|
2222
|
+
:auth_names => auth_names,
|
|
2223
|
+
:return_type => 'AccountSharedAccess')
|
|
2224
|
+
if @api_client.config.debugging
|
|
2225
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_shared_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2226
|
+
end
|
|
2227
|
+
return data, status_code, headers
|
|
2228
|
+
end
|
|
2229
|
+
end
|
|
2230
|
+
end
|