docusign_esign 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE +21 -0
- data/README.md +101 -0
- data/Rakefile +8 -0
- data/docs/AccountAddress.md +19 -0
- data/docs/AccountBillingPlan.md +27 -0
- data/docs/AccountBillingPlanResponse.md +13 -0
- data/docs/AccountInformation.md +38 -0
- data/docs/AccountRoleSettings.md +71 -0
- data/docs/AccountSettingsInformation.md +8 -0
- data/docs/AccountSharedAccess.md +16 -0
- data/docs/AccountSignatureProvider.md +14 -0
- data/docs/AccountSignatureProviderOption.md +10 -0
- data/docs/AccountSignatureProviders.md +8 -0
- data/docs/AccountsApi.md +1997 -0
- data/docs/AddOn.md +11 -0
- data/docs/AddressInformation.md +15 -0
- data/docs/AddressInformationInput.md +10 -0
- data/docs/AddressInformationV2.md +15 -0
- data/docs/Agent.md +49 -0
- data/docs/ApiRequestLog.md +11 -0
- data/docs/ApiRequestLogsResult.md +8 -0
- data/docs/AppStoreProduct.md +9 -0
- data/docs/AppStoreReceipt.md +9 -0
- data/docs/Approve.md +40 -0
- data/docs/Attachment.md +14 -0
- data/docs/AuthenticationApi.md +356 -0
- data/docs/AuthenticationMethod.md +11 -0
- data/docs/AuthenticationStatus.md +24 -0
- data/docs/BccEmailAddress.md +9 -0
- data/docs/BillingApi.md +569 -0
- data/docs/BillingCharge.md +20 -0
- data/docs/BillingChargeResponse.md +8 -0
- data/docs/BillingDiscount.md +10 -0
- data/docs/BillingInvoice.md +17 -0
- data/docs/BillingInvoiceItem.md +12 -0
- data/docs/BillingInvoicesResponse.md +10 -0
- data/docs/BillingInvoicesSummary.md +10 -0
- data/docs/BillingPayment.md +10 -0
- data/docs/BillingPaymentItem.md +12 -0
- data/docs/BillingPaymentRequest.md +8 -0
- data/docs/BillingPaymentResponse.md +8 -0
- data/docs/BillingPaymentsResponse.md +10 -0
- data/docs/BillingPlan.md +22 -0
- data/docs/BillingPlanInformation.md +22 -0
- data/docs/BillingPlanPreview.md +13 -0
- data/docs/BillingPlanResponse.md +9 -0
- data/docs/BillingPlanUpdateResponse.md +14 -0
- data/docs/BillingPlansResponse.md +8 -0
- data/docs/BillingPrice.md +10 -0
- data/docs/Brand.md +20 -0
- data/docs/BrandEmailContent.md +11 -0
- data/docs/BrandLink.md +11 -0
- data/docs/BrandLogos.md +10 -0
- data/docs/BrandRequest.md +8 -0
- data/docs/BrandResourceUrls.md +11 -0
- data/docs/BrandResources.md +14 -0
- data/docs/BrandResourcesList.md +8 -0
- data/docs/BrandsRequest.md +8 -0
- data/docs/BrandsResponse.md +10 -0
- data/docs/BulkEnvelope.md +16 -0
- data/docs/BulkEnvelopeStatus.md +21 -0
- data/docs/BulkEnvelopesApi.md +295 -0
- data/docs/BulkEnvelopesResponse.md +14 -0
- data/docs/BulkRecipient.md +17 -0
- data/docs/BulkRecipientSignatureProvider.md +9 -0
- data/docs/BulkRecipientTabLabel.md +9 -0
- data/docs/BulkRecipientsRequest.md +8 -0
- data/docs/BulkRecipientsResponse.md +14 -0
- data/docs/BulkRecipientsSummaryResponse.md +11 -0
- data/docs/BulkRecipientsUpdateResponse.md +8 -0
- data/docs/CaptiveRecipient.md +11 -0
- data/docs/CaptiveRecipientInformation.md +8 -0
- data/docs/CarbonCopy.md +49 -0
- data/docs/CertifiedDelivery.md +49 -0
- data/docs/Checkbox.md +37 -0
- data/docs/ChunkedUploadPart.md +9 -0
- data/docs/ChunkedUploadRequest.md +9 -0
- data/docs/ChunkedUploadResponse.md +14 -0
- data/docs/CloudStorageApi.md +424 -0
- data/docs/CloudStorageProvider.md +12 -0
- data/docs/CloudStorageProviders.md +8 -0
- data/docs/Company.md +46 -0
- data/docs/CompositeTemplate.md +12 -0
- data/docs/ConnectApi.md +891 -0
- data/docs/ConnectConfigResults.md +9 -0
- data/docs/ConnectCustomConfiguration.md +28 -0
- data/docs/ConnectDebugLog.md +12 -0
- data/docs/ConnectFailureFilter.md +9 -0
- data/docs/ConnectFailureResult.md +12 -0
- data/docs/ConnectFailureResults.md +8 -0
- data/docs/ConnectLog.md +25 -0
- data/docs/ConnectLogs.md +11 -0
- data/docs/ConsoleViewRequest.md +9 -0
- data/docs/ConsumerDisclosure.md +37 -0
- data/docs/Contact.md +16 -0
- data/docs/ContactGetResponse.md +14 -0
- data/docs/ContactModRequest.md +8 -0
- data/docs/ContactUpdateResponse.md +8 -0
- data/docs/CorrectViewRequest.md +9 -0
- data/docs/Country.md +11 -0
- data/docs/CreditCardInformation.md +13 -0
- data/docs/CreditCardTypes.md +8 -0
- data/docs/CurrencyFeatureSetPrice.md +12 -0
- data/docs/CurrencyPlanPrice.md +13 -0
- data/docs/CustomFieldV2.md +14 -0
- data/docs/CustomFields.md +9 -0
- data/docs/CustomFieldsEnvelope.md +9 -0
- data/docs/CustomSettingsInformation.md +8 -0
- data/docs/CustomTabsApi.md +268 -0
- data/docs/Date.md +52 -0
- data/docs/DateSigned.md +39 -0
- data/docs/Decline.md +41 -0
- data/docs/DiagnosticsApi.md +321 -0
- data/docs/DiagnosticsSettingsInformation.md +10 -0
- data/docs/DobInformationInput.md +10 -0
- data/docs/Document.md +27 -0
- data/docs/DocumentFieldsInformation.md +8 -0
- data/docs/DocumentTemplate.md +12 -0
- data/docs/DocumentTemplateList.md +8 -0
- data/docs/DocumentVisibility.md +12 -0
- data/docs/DocumentVisibilityList.md +8 -0
- data/docs/ENoteConfiguration.md +12 -0
- data/docs/Editor.md +48 -0
- data/docs/Email.md +52 -0
- data/docs/EmailAddress.md +38 -0
- data/docs/EmailSettings.md +10 -0
- data/docs/Envelope.md +54 -0
- data/docs/EnvelopeAttachment.md +13 -0
- data/docs/EnvelopeAttachmentsRequest.md +8 -0
- data/docs/EnvelopeAttachmentsResult.md +8 -0
- data/docs/EnvelopeAuditEvent.md +8 -0
- data/docs/EnvelopeAuditEventResponse.md +8 -0
- data/docs/EnvelopeDefinition.md +63 -0
- data/docs/EnvelopeDocument.md +24 -0
- data/docs/EnvelopeDocumentsResult.md +9 -0
- data/docs/EnvelopeEvent.md +9 -0
- data/docs/EnvelopeFormData.md +13 -0
- data/docs/EnvelopeId.md +38 -0
- data/docs/EnvelopeIdsRequest.md +9 -0
- data/docs/EnvelopeNotificationRequest.md +10 -0
- data/docs/EnvelopeSummary.md +11 -0
- data/docs/EnvelopeTemplate.md +56 -0
- data/docs/EnvelopeTemplateDefinition.md +22 -0
- data/docs/EnvelopeTemplateResult.md +68 -0
- data/docs/EnvelopeTemplateResults.md +15 -0
- data/docs/EnvelopeTransactionStatus.md +11 -0
- data/docs/EnvelopeUpdateSummary.md +15 -0
- data/docs/EnvelopesApi.md +4306 -0
- data/docs/EnvelopesInformation.md +15 -0
- data/docs/ErrorDetails.md +9 -0
- data/docs/EventNotification.md +22 -0
- data/docs/EventResult.md +11 -0
- data/docs/Expirations.md +10 -0
- data/docs/ExternalDocServiceErrorDetails.md +10 -0
- data/docs/ExternalFile.md +15 -0
- data/docs/ExternalFolder.md +17 -0
- data/docs/FeatureSet.md +16 -0
- data/docs/FileType.md +9 -0
- data/docs/FileTypeList.md +8 -0
- data/docs/Filter.md +18 -0
- data/docs/FirstName.md +38 -0
- data/docs/Folder.md +19 -0
- data/docs/FolderItem.md +28 -0
- data/docs/FolderItemResponse.md +14 -0
- data/docs/FolderItemV2.md +27 -0
- data/docs/FolderItemsResponse.md +14 -0
- data/docs/FoldersApi.md +261 -0
- data/docs/FoldersRequest.md +9 -0
- data/docs/FoldersResponse.md +8 -0
- data/docs/ForgottenPasswordInformation.md +15 -0
- data/docs/FormulaTab.md +56 -0
- data/docs/FullName.md +38 -0
- data/docs/Group.md +13 -0
- data/docs/GroupInformation.md +14 -0
- data/docs/GroupsApi.md +552 -0
- data/docs/IdCheckInformationInput.md +11 -0
- data/docs/InPersonSigner.md +62 -0
- data/docs/InitialHere.md +34 -0
- data/docs/InlineTemplate.md +12 -0
- data/docs/IntegratedUserInfoList.md +15 -0
- data/docs/Intermediary.md +49 -0
- data/docs/LastName.md +38 -0
- data/docs/List.md +46 -0
- data/docs/ListCustomField.md +15 -0
- data/docs/ListItem.md +10 -0
- data/docs/LockInformation.md +15 -0
- data/docs/LockRequest.md +12 -0
- data/docs/LoginAccount.md +18 -0
- data/docs/LoginInformation.md +9 -0
- data/docs/MatchBox.md +12 -0
- data/docs/MemberGroupSharedItem.md +10 -0
- data/docs/MemberSharedItems.md +11 -0
- data/docs/MergeField.md +12 -0
- data/docs/MobileNotifierConfiguration.md +10 -0
- data/docs/MobileNotifierConfigurationInformation.md +8 -0
- data/docs/Money.md +10 -0
- data/docs/NameValue.md +11 -0
- data/docs/NewAccountDefinition.md +17 -0
- data/docs/NewAccountSummary.md +14 -0
- data/docs/NewUser.md +17 -0
- data/docs/NewUsersDefinition.md +8 -0
- data/docs/NewUsersSummary.md +8 -0
- data/docs/NotaryHost.md +47 -0
- data/docs/Note.md +42 -0
- data/docs/Notification.md +10 -0
- data/docs/Number.md +54 -0
- data/docs/OauthAccess.md +13 -0
- data/docs/OfflineAttributes.md +13 -0
- data/docs/Page.md +15 -0
- data/docs/PageImages.md +14 -0
- data/docs/PageRequest.md +9 -0
- data/docs/PaymentDetails.md +12 -0
- data/docs/PaymentLineItem.md +11 -0
- data/docs/PermissionProfile.md +14 -0
- data/docs/PermissionProfileInformation.md +8 -0
- data/docs/PlanInformation.md +13 -0
- data/docs/PostTransactionsRequest.md +11 -0
- data/docs/PostTransactionsResponse.md +9 -0
- data/docs/PowerForm.md +31 -0
- data/docs/PowerFormFormDataEnvelope.md +9 -0
- data/docs/PowerFormFormDataRecipient.md +11 -0
- data/docs/PowerFormRecipient.md +20 -0
- data/docs/PowerFormSendersResponse.md +14 -0
- data/docs/PowerFormsApi.md +419 -0
- data/docs/PowerFormsFormDataResponse.md +8 -0
- data/docs/PowerFormsRequest.md +8 -0
- data/docs/PowerFormsResponse.md +14 -0
- data/docs/PropertyMetadata.md +9 -0
- data/docs/Province.md +9 -0
- data/docs/ProvisioningInformation.md +14 -0
- data/docs/PurchasedEnvelopesInformation.md +16 -0
- data/docs/Radio.md +25 -0
- data/docs/RadioGroup.md +16 -0
- data/docs/RecipientAttachment.md +13 -0
- data/docs/RecipientDomain.md +11 -0
- data/docs/RecipientEmailNotification.md +10 -0
- data/docs/RecipientEvent.md +9 -0
- data/docs/RecipientFormData.md +15 -0
- data/docs/RecipientNamesResponse.md +10 -0
- data/docs/RecipientPhoneAuthentication.md +11 -0
- data/docs/RecipientSAMLAuthentication.md +8 -0
- data/docs/RecipientSMSAuthentication.md +8 -0
- data/docs/RecipientSignatureInformation.md +10 -0
- data/docs/RecipientSignatureProvider.md +9 -0
- data/docs/RecipientSignatureProviderOptions.md +11 -0
- data/docs/RecipientUpdateResponse.md +10 -0
- data/docs/RecipientViewRequest.md +21 -0
- data/docs/Recipients.md +17 -0
- data/docs/RecipientsUpdateSummary.md +8 -0
- data/docs/ReferralInformation.md +25 -0
- data/docs/Reminders.md +10 -0
- data/docs/ResourceInformation.md +8 -0
- data/docs/ReturnUrlRequest.md +8 -0
- data/docs/SamlAssertionAttribute.md +11 -0
- data/docs/SeatDiscount.md +10 -0
- data/docs/SenderEmailNotifications.md +14 -0
- data/docs/ServerTemplate.md +9 -0
- data/docs/ServiceInformation.md +13 -0
- data/docs/ServiceVersion.md +9 -0
- data/docs/SettingsMetadata.md +13 -0
- data/docs/SharedItem.md +10 -0
- data/docs/SignHere.md +34 -0
- data/docs/SignatureProviderRequiredOption.md +9 -0
- data/docs/SignatureType.md +9 -0
- data/docs/Signer.md +63 -0
- data/docs/SignerAttachment.md +34 -0
- data/docs/SignerEmailNotifications.md +21 -0
- data/docs/SigningGroup.md +17 -0
- data/docs/SigningGroupInformation.md +8 -0
- data/docs/SigningGroupUser.md +10 -0
- data/docs/SigningGroupUsers.md +8 -0
- data/docs/SigningGroupsApi.md +485 -0
- data/docs/SocialAccountInformation.md +12 -0
- data/docs/SocialAuthentication.md +8 -0
- data/docs/Ssn.md +52 -0
- data/docs/Ssn4InformationInput.md +10 -0
- data/docs/Ssn9InformationInput.md +9 -0
- data/docs/TabAccountSettings.md +45 -0
- data/docs/TabMetadata.md +46 -0
- data/docs/TabMetadataList.md +8 -0
- data/docs/Tabs.md +32 -0
- data/docs/TemplateCustomFields.md +9 -0
- data/docs/TemplateDocumentVisibilityList.md +8 -0
- data/docs/TemplateDocumentsResult.md +9 -0
- data/docs/TemplateInformation.md +8 -0
- data/docs/TemplateMatch.md +10 -0
- data/docs/TemplateNotificationRequest.md +11 -0
- data/docs/TemplateRecipients.md +17 -0
- data/docs/TemplateRole.md +19 -0
- data/docs/TemplateSharedItem.md +14 -0
- data/docs/TemplateSummary.md +14 -0
- data/docs/TemplateTabs.md +32 -0
- data/docs/TemplateUpdateSummary.md +15 -0
- data/docs/TemplatesApi.md +2349 -0
- data/docs/Text.md +55 -0
- data/docs/TextCustomField.md +14 -0
- data/docs/Title.md +46 -0
- data/docs/UsageHistory.md +11 -0
- data/docs/UserAccountManagementGranularInformation.md +15 -0
- data/docs/UserInfo.md +17 -0
- data/docs/UserInfoList.md +8 -0
- data/docs/UserInformation.md +41 -0
- data/docs/UserInformationList.md +14 -0
- data/docs/UserPasswordInformation.md +11 -0
- data/docs/UserProfile.md +19 -0
- data/docs/UserSettingsInformation.md +11 -0
- data/docs/UserSharedItem.md +10 -0
- data/docs/UserSignature.md +20 -0
- data/docs/UserSignatureDefinition.md +11 -0
- data/docs/UserSignaturesInformation.md +8 -0
- data/docs/UserSocialIdResult.md +9 -0
- data/docs/UsersApi.md +1566 -0
- data/docs/UsersResponse.md +14 -0
- data/docs/View.md +42 -0
- data/docs/ViewLinkRequest.md +9 -0
- data/docs/ViewUrl.md +8 -0
- data/docs/Workspace.md +18 -0
- data/docs/WorkspaceFolderContents.md +15 -0
- data/docs/WorkspaceItem.md +26 -0
- data/docs/WorkspaceItemList.md +8 -0
- data/docs/WorkspaceList.md +12 -0
- data/docs/WorkspaceUser.md +23 -0
- data/docs/WorkspaceUserAuthorization.md +18 -0
- data/docs/WorkspacesApi.md +630 -0
- data/docs/Zip.md +53 -0
- data/docusign_esign-1.0.0.gem +0 -0
- data/docusign_esign.gemspec +47 -0
- data/git_push.sh +55 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/accounts_api.rb +2230 -0
- data/lib/docusign_esign/api/authentication_api.rb +393 -0
- data/lib/docusign_esign/api/billing_api.rb +636 -0
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +355 -0
- data/lib/docusign_esign/api/cloud_storage_api.rb +507 -0
- data/lib/docusign_esign/api/connect_api.rb +967 -0
- data/lib/docusign_esign/api/custom_tabs_api.rb +296 -0
- data/lib/docusign_esign/api/diagnostics_api.rb +356 -0
- data/lib/docusign_esign/api/envelopes_api.rb +4737 -0
- data/lib/docusign_esign/api/folders_api.rb +342 -0
- data/lib/docusign_esign/api/groups_api.rb +596 -0
- data/lib/docusign_esign/api/power_forms_api.rb +489 -0
- data/lib/docusign_esign/api/signing_groups_api.rb +513 -0
- data/lib/docusign_esign/api/templates_api.rb +2555 -0
- data/lib/docusign_esign/api/users_api.rb +1694 -0
- data/lib/docusign_esign/api/workspaces_api.rb +719 -0
- data/lib/docusign_esign/api_client.rb +421 -0
- data/lib/docusign_esign/api_error.rb +37 -0
- data/lib/docusign_esign/configuration.rb +195 -0
- data/lib/docusign_esign/models/account_address.rb +300 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +384 -0
- data/lib/docusign_esign/models/account_billing_plan_response.rb +236 -0
- data/lib/docusign_esign/models/account_information.rb +488 -0
- data/lib/docusign_esign/models/account_role_settings.rb +786 -0
- data/lib/docusign_esign/models/account_settings_information.rb +190 -0
- data/lib/docusign_esign/models/account_shared_access.rb +269 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +252 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +208 -0
- data/lib/docusign_esign/models/account_signature_providers.rb +190 -0
- data/lib/docusign_esign/models/add_on.rb +218 -0
- data/lib/docusign_esign/models/address_information.rb +258 -0
- data/lib/docusign_esign/models/address_information_input.rb +207 -0
- data/lib/docusign_esign/models/address_information_v2.rb +258 -0
- data/lib/docusign_esign/models/agent.rb +603 -0
- data/lib/docusign_esign/models/api_request_log.rb +218 -0
- data/lib/docusign_esign/models/api_request_logs_result.rb +190 -0
- data/lib/docusign_esign/models/app_store_product.rb +198 -0
- data/lib/docusign_esign/models/app_store_receipt.rb +198 -0
- data/lib/docusign_esign/models/approve.rb +506 -0
- data/lib/docusign_esign/models/attachment.rb +248 -0
- data/lib/docusign_esign/models/authentication_method.rb +218 -0
- data/lib/docusign_esign/models/authentication_status.rb +331 -0
- data/lib/docusign_esign/models/bcc_email_address.rb +198 -0
- data/lib/docusign_esign/models/billing_charge.rb +312 -0
- data/lib/docusign_esign/models/billing_charge_response.rb +190 -0
- data/lib/docusign_esign/models/billing_discount.rb +208 -0
- data/lib/docusign_esign/models/billing_invoice.rb +280 -0
- data/lib/docusign_esign/models/billing_invoice_item.rb +228 -0
- data/lib/docusign_esign/models/billing_invoices_response.rb +210 -0
- data/lib/docusign_esign/models/billing_invoices_summary.rb +210 -0
- data/lib/docusign_esign/models/billing_payment.rb +208 -0
- data/lib/docusign_esign/models/billing_payment_item.rb +228 -0
- data/lib/docusign_esign/models/billing_payment_request.rb +188 -0
- data/lib/docusign_esign/models/billing_payment_response.rb +190 -0
- data/lib/docusign_esign/models/billing_payments_response.rb +210 -0
- data/lib/docusign_esign/models/billing_plan.rb +336 -0
- data/lib/docusign_esign/models/billing_plan_information.rb +323 -0
- data/lib/docusign_esign/models/billing_plan_preview.rb +237 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +199 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +247 -0
- data/lib/docusign_esign/models/billing_plans_response.rb +190 -0
- data/lib/docusign_esign/models/billing_price.rb +208 -0
- data/lib/docusign_esign/models/brand.rb +313 -0
- data/lib/docusign_esign/models/brand_email_content.rb +218 -0
- data/lib/docusign_esign/models/brand_link.rb +218 -0
- data/lib/docusign_esign/models/brand_logos.rb +208 -0
- data/lib/docusign_esign/models/brand_request.rb +188 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +218 -0
- data/lib/docusign_esign/models/brand_resources.rb +248 -0
- data/lib/docusign_esign/models/brand_resources_list.rb +190 -0
- data/lib/docusign_esign/models/brands_request.rb +190 -0
- data/lib/docusign_esign/models/brands_response.rb +210 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +267 -0
- data/lib/docusign_esign/models/bulk_envelope_status.rb +320 -0
- data/lib/docusign_esign/models/bulk_envelopes_response.rb +250 -0
- data/lib/docusign_esign/models/bulk_recipient.rb +284 -0
- data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +198 -0
- data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +198 -0
- data/lib/docusign_esign/models/bulk_recipients_request.rb +190 -0
- data/lib/docusign_esign/models/bulk_recipients_response.rb +250 -0
- data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +222 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +187 -0
- data/lib/docusign_esign/models/captive_recipient.rb +217 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +190 -0
- data/lib/docusign_esign/models/carbon_copy.rb +603 -0
- data/lib/docusign_esign/models/certified_delivery.rb +603 -0
- data/lib/docusign_esign/models/checkbox.rb +476 -0
- data/lib/docusign_esign/models/chunked_upload_part.rb +198 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +198 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +250 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +227 -0
- data/lib/docusign_esign/models/cloud_storage_providers.rb +190 -0
- data/lib/docusign_esign/models/company.rb +566 -0
- data/lib/docusign_esign/models/composite_template.rb +231 -0
- data/lib/docusign_esign/models/connect_config_results.rb +200 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +388 -0
- data/lib/docusign_esign/models/connect_debug_log.rb +227 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +200 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +228 -0
- data/lib/docusign_esign/models/connect_failure_results.rb +190 -0
- data/lib/docusign_esign/models/connect_log.rb +360 -0
- data/lib/docusign_esign/models/connect_logs.rb +222 -0
- data/lib/docusign_esign/models/console_view_request.rb +198 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +478 -0
- data/lib/docusign_esign/models/contact.rb +269 -0
- data/lib/docusign_esign/models/contact_get_response.rb +250 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +190 -0
- data/lib/docusign_esign/models/contact_update_response.rb +190 -0
- data/lib/docusign_esign/models/correct_view_request.rb +198 -0
- data/lib/docusign_esign/models/country.rb +220 -0
- data/lib/docusign_esign/models/credit_card_information.rb +237 -0
- data/lib/docusign_esign/models/credit_card_types.rb +190 -0
- data/lib/docusign_esign/models/currency_feature_set_price.rb +228 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +237 -0
- data/lib/docusign_esign/models/custom_field_v2.rb +247 -0
- data/lib/docusign_esign/models/custom_fields.rb +202 -0
- data/lib/docusign_esign/models/custom_fields_envelope.rb +202 -0
- data/lib/docusign_esign/models/custom_settings_information.rb +190 -0
- data/lib/docusign_esign/models/date.rb +626 -0
- data/lib/docusign_esign/models/date_signed.rb +496 -0
- data/lib/docusign_esign/models/decline.rb +516 -0
- data/lib/docusign_esign/models/diagnostics_settings_information.rb +208 -0
- data/lib/docusign_esign/models/dob_information_input.rb +208 -0
- data/lib/docusign_esign/models/document.rb +382 -0
- data/lib/docusign_esign/models/document_fields_information.rb +190 -0
- data/lib/docusign_esign/models/document_template.rb +227 -0
- data/lib/docusign_esign/models/document_template_list.rb +190 -0
- data/lib/docusign_esign/models/document_visibility.rb +227 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +190 -0
- data/lib/docusign_esign/models/e_note_configuration.rb +228 -0
- data/lib/docusign_esign/models/editor.rb +591 -0
- data/lib/docusign_esign/models/email.rb +626 -0
- data/lib/docusign_esign/models/email_address.rb +486 -0
- data/lib/docusign_esign/models/email_settings.rb +210 -0
- data/lib/docusign_esign/models/envelope.rb +643 -0
- data/lib/docusign_esign/models/envelope_attachment.rb +237 -0
- data/lib/docusign_esign/models/envelope_attachments_request.rb +190 -0
- data/lib/docusign_esign/models/envelope_attachments_result.rb +190 -0
- data/lib/docusign_esign/models/envelope_audit_event.rb +190 -0
- data/lib/docusign_esign/models/envelope_audit_event_response.rb +190 -0
- data/lib/docusign_esign/models/envelope_definition.rb +740 -0
- data/lib/docusign_esign/models/envelope_document.rb +351 -0
- data/lib/docusign_esign/models/envelope_documents_result.rb +200 -0
- data/lib/docusign_esign/models/envelope_event.rb +198 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +242 -0
- data/lib/docusign_esign/models/envelope_id.rb +486 -0
- data/lib/docusign_esign/models/envelope_ids_request.rb +202 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +206 -0
- data/lib/docusign_esign/models/envelope_summary.rb +218 -0
- data/lib/docusign_esign/models/envelope_template.rb +664 -0
- data/lib/docusign_esign/models/envelope_template_definition.rb +326 -0
- data/lib/docusign_esign/models/envelope_template_result.rb +784 -0
- data/lib/docusign_esign/models/envelope_template_results.rb +262 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +217 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +260 -0
- data/lib/docusign_esign/models/envelopes_information.rb +262 -0
- data/lib/docusign_esign/models/error_details.rb +198 -0
- data/lib/docusign_esign/models/event_notification.rb +332 -0
- data/lib/docusign_esign/models/event_result.rb +218 -0
- data/lib/docusign_esign/models/expirations.rb +208 -0
- data/lib/docusign_esign/models/external_doc_service_error_details.rb +208 -0
- data/lib/docusign_esign/models/external_file.rb +258 -0
- data/lib/docusign_esign/models/external_folder.rb +279 -0
- data/lib/docusign_esign/models/feature_set.rb +270 -0
- data/lib/docusign_esign/models/file_type.rb +198 -0
- data/lib/docusign_esign/models/file_type_list.rb +190 -0
- data/lib/docusign_esign/models/filter.rb +288 -0
- data/lib/docusign_esign/models/first_name.rb +486 -0
- data/lib/docusign_esign/models/folder.rb +298 -0
- data/lib/docusign_esign/models/folder_item.rb +390 -0
- data/lib/docusign_esign/models/folder_item_response.rb +250 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +377 -0
- data/lib/docusign_esign/models/folder_items_response.rb +250 -0
- data/lib/docusign_esign/models/folders_request.rb +200 -0
- data/lib/docusign_esign/models/folders_response.rb +190 -0
- data/lib/docusign_esign/models/forgotten_password_information.rb +258 -0
- data/lib/docusign_esign/models/formula_tab.rb +665 -0
- data/lib/docusign_esign/models/full_name.rb +486 -0
- data/lib/docusign_esign/models/group.rb +239 -0
- data/lib/docusign_esign/models/group_information.rb +250 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +214 -0
- data/lib/docusign_esign/models/in_person_signer.rb +729 -0
- data/lib/docusign_esign/models/initial_here.rb +446 -0
- data/lib/docusign_esign/models/inline_template.rb +227 -0
- data/lib/docusign_esign/models/integrated_user_info_list.rb +260 -0
- data/lib/docusign_esign/models/intermediary.rb +603 -0
- data/lib/docusign_esign/models/last_name.rb +486 -0
- data/lib/docusign_esign/models/list.rb +568 -0
- data/lib/docusign_esign/models/list_custom_field.rb +259 -0
- data/lib/docusign_esign/models/list_item.rb +208 -0
- data/lib/docusign_esign/models/lock_information.rb +256 -0
- data/lib/docusign_esign/models/lock_request.rb +228 -0
- data/lib/docusign_esign/models/login_account.rb +292 -0
- data/lib/docusign_esign/models/login_information.rb +200 -0
- data/lib/docusign_esign/models/match_box.rb +228 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +206 -0
- data/lib/docusign_esign/models/member_shared_items.rb +220 -0
- data/lib/docusign_esign/models/merge_field.rb +228 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +207 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +190 -0
- data/lib/docusign_esign/models/money.rb +208 -0
- data/lib/docusign_esign/models/name_value.rb +217 -0
- data/lib/docusign_esign/models/new_account_definition.rb +274 -0
- data/lib/docusign_esign/models/new_account_summary.rb +247 -0
- data/lib/docusign_esign/models/new_user.rb +277 -0
- data/lib/docusign_esign/models/new_users_definition.rb +190 -0
- data/lib/docusign_esign/models/new_users_summary.rb +190 -0
- data/lib/docusign_esign/models/notary_host.rb +577 -0
- data/lib/docusign_esign/models/note.rb +526 -0
- data/lib/docusign_esign/models/notification.rb +206 -0
- data/lib/docusign_esign/models/number.rb +646 -0
- data/lib/docusign_esign/models/oauth_access.rb +240 -0
- data/lib/docusign_esign/models/offline_attributes.rb +238 -0
- data/lib/docusign_esign/models/page.rb +257 -0
- data/lib/docusign_esign/models/page_images.rb +250 -0
- data/lib/docusign_esign/models/page_request.rb +198 -0
- data/lib/docusign_esign/models/payment_details.rb +229 -0
- data/lib/docusign_esign/models/payment_line_item.rb +218 -0
- data/lib/docusign_esign/models/permission_profile.rb +249 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +190 -0
- data/lib/docusign_esign/models/plan_information.rb +244 -0
- data/lib/docusign_esign/models/post_transactions_request.rb +218 -0
- data/lib/docusign_esign/models/post_transactions_response.rb +198 -0
- data/lib/docusign_esign/models/power_form.rb +421 -0
- data/lib/docusign_esign/models/power_form_form_data_envelope.rb +200 -0
- data/lib/docusign_esign/models/power_form_form_data_recipient.rb +220 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +308 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +250 -0
- data/lib/docusign_esign/models/power_forms_form_data_response.rb +190 -0
- data/lib/docusign_esign/models/power_forms_request.rb +190 -0
- data/lib/docusign_esign/models/power_forms_response.rb +250 -0
- data/lib/docusign_esign/models/property_metadata.rb +200 -0
- data/lib/docusign_esign/models/province.rb +198 -0
- data/lib/docusign_esign/models/provisioning_information.rb +248 -0
- data/lib/docusign_esign/models/purchased_envelopes_information.rb +268 -0
- data/lib/docusign_esign/models/radio.rb +357 -0
- data/lib/docusign_esign/models/radio_group.rb +270 -0
- data/lib/docusign_esign/models/recipient_attachment.rb +238 -0
- data/lib/docusign_esign/models/recipient_domain.rb +218 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +208 -0
- data/lib/docusign_esign/models/recipient_event.rb +198 -0
- data/lib/docusign_esign/models/recipient_form_data.rb +260 -0
- data/lib/docusign_esign/models/recipient_names_response.rb +210 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +220 -0
- data/lib/docusign_esign/models/recipient_saml_authentication.rb +190 -0
- data/lib/docusign_esign/models/recipient_signature_information.rb +208 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +197 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +218 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +190 -0
- data/lib/docusign_esign/models/recipient_update_response.rb +206 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +318 -0
- data/lib/docusign_esign/models/recipients.rb +291 -0
- data/lib/docusign_esign/models/recipients_update_summary.rb +190 -0
- data/lib/docusign_esign/models/referral_information.rb +358 -0
- data/lib/docusign_esign/models/reminders.rb +208 -0
- data/lib/docusign_esign/models/resource_information.rb +190 -0
- data/lib/docusign_esign/models/return_url_request.rb +188 -0
- data/lib/docusign_esign/models/saml_assertion_attribute.rb +217 -0
- data/lib/docusign_esign/models/seat_discount.rb +208 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +248 -0
- data/lib/docusign_esign/models/server_template.rb +198 -0
- data/lib/docusign_esign/models/service_information.rb +242 -0
- data/lib/docusign_esign/models/service_version.rb +198 -0
- data/lib/docusign_esign/models/settings_metadata.rb +240 -0
- data/lib/docusign_esign/models/shared_item.rb +206 -0
- data/lib/docusign_esign/models/sign_here.rb +446 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +200 -0
- data/lib/docusign_esign/models/signature_type.rb +198 -0
- data/lib/docusign_esign/models/signer.rb +742 -0
- data/lib/docusign_esign/models/signer_attachment.rb +446 -0
- data/lib/docusign_esign/models/signer_email_notifications.rb +318 -0
- data/lib/docusign_esign/models/signing_group.rb +279 -0
- data/lib/docusign_esign/models/signing_group_information.rb +190 -0
- data/lib/docusign_esign/models/signing_group_user.rb +207 -0
- data/lib/docusign_esign/models/signing_group_users.rb +190 -0
- data/lib/docusign_esign/models/social_account_information.rb +227 -0
- data/lib/docusign_esign/models/social_authentication.rb +188 -0
- data/lib/docusign_esign/models/ssn.rb +626 -0
- data/lib/docusign_esign/models/ssn4_information_input.rb +208 -0
- data/lib/docusign_esign/models/ssn9_information_input.rb +198 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +539 -0
- data/lib/docusign_esign/models/tab_metadata.rb +569 -0
- data/lib/docusign_esign/models/tab_metadata_list.rb +190 -0
- data/lib/docusign_esign/models/tabs.rb +478 -0
- data/lib/docusign_esign/models/template_custom_fields.rb +202 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +190 -0
- data/lib/docusign_esign/models/template_documents_result.rb +200 -0
- data/lib/docusign_esign/models/template_information.rb +190 -0
- data/lib/docusign_esign/models/template_match.rb +208 -0
- data/lib/docusign_esign/models/template_notification_request.rb +216 -0
- data/lib/docusign_esign/models/template_recipients.rb +291 -0
- data/lib/docusign_esign/models/template_role.rb +296 -0
- data/lib/docusign_esign/models/template_shared_item.rb +250 -0
- data/lib/docusign_esign/models/template_summary.rb +247 -0
- data/lib/docusign_esign/models/template_tabs.rb +478 -0
- data/lib/docusign_esign/models/template_update_summary.rb +260 -0
- data/lib/docusign_esign/models/text.rb +656 -0
- data/lib/docusign_esign/models/text_custom_field.rb +247 -0
- data/lib/docusign_esign/models/title.rb +566 -0
- data/lib/docusign_esign/models/usage_history.rb +218 -0
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +254 -0
- data/lib/docusign_esign/models/user_info.rb +277 -0
- data/lib/docusign_esign/models/user_info_list.rb +190 -0
- data/lib/docusign_esign/models/user_information.rb +519 -0
- data/lib/docusign_esign/models/user_information_list.rb +250 -0
- data/lib/docusign_esign/models/user_password_information.rb +217 -0
- data/lib/docusign_esign/models/user_profile.rb +297 -0
- data/lib/docusign_esign/models/user_settings_information.rb +217 -0
- data/lib/docusign_esign/models/user_shared_item.rb +206 -0
- data/lib/docusign_esign/models/user_signature.rb +307 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +218 -0
- data/lib/docusign_esign/models/user_signatures_information.rb +190 -0
- data/lib/docusign_esign/models/user_social_id_result.rb +200 -0
- data/lib/docusign_esign/models/users_response.rb +250 -0
- data/lib/docusign_esign/models/view.rb +526 -0
- data/lib/docusign_esign/models/view_link_request.rb +198 -0
- data/lib/docusign_esign/models/view_url.rb +188 -0
- data/lib/docusign_esign/models/workspace.rb +286 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +261 -0
- data/lib/docusign_esign/models/workspace_item.rb +365 -0
- data/lib/docusign_esign/models/workspace_item_list.rb +190 -0
- data/lib/docusign_esign/models/workspace_list.rb +230 -0
- data/lib/docusign_esign/models/workspace_user.rb +337 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +286 -0
- data/lib/docusign_esign/models/zip.rb +636 -0
- data/lib/docusign_esign/version.rb +14 -0
- data/lib/docusign_esign.rb +360 -0
- data/spec/api/accounts_api_spec.rb +556 -0
- data/spec/api/authentication_api_spec.rb +125 -0
- data/spec/api/billing_api_spec.rb +178 -0
- data/spec/api/bulk_envelopes_api_spec.rb +110 -0
- data/spec/api/cloud_storage_api_spec.rb +146 -0
- data/spec/api/connect_api_spec.rb +261 -0
- data/spec/api/custom_tabs_api_spec.rb +100 -0
- data/spec/api/diagnostics_api_spec.rb +114 -0
- data/spec/api/envelopes_api_spec.rb +1171 -0
- data/spec/api/folders_api_spec.rb +107 -0
- data/spec/api/groups_api_spec.rb +174 -0
- data/spec/api/power_forms_api_spec.rb +144 -0
- data/spec/api/signing_groups_api_spec.rb +155 -0
- data/spec/api/templates_api_spec.rb +649 -0
- data/spec/api/users_api_spec.rb +442 -0
- data/spec/api/workspaces_api_spec.rb +201 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/account_address_spec.rb +107 -0
- data/spec/models/account_billing_plan_response_spec.rb +71 -0
- data/spec/models/account_billing_plan_spec.rb +155 -0
- data/spec/models/account_information_spec.rb +221 -0
- data/spec/models/account_role_settings_spec.rb +419 -0
- data/spec/models/account_settings_information_spec.rb +41 -0
- data/spec/models/account_shared_access_spec.rb +89 -0
- data/spec/models/account_signature_provider_option_spec.rb +53 -0
- data/spec/models/account_signature_provider_spec.rb +77 -0
- data/spec/models/account_signature_providers_spec.rb +41 -0
- data/spec/models/add_on_spec.rb +59 -0
- data/spec/models/address_information_input_spec.rb +53 -0
- data/spec/models/address_information_spec.rb +83 -0
- data/spec/models/address_information_v2_spec.rb +83 -0
- data/spec/models/agent_spec.rb +287 -0
- data/spec/models/api_request_log_spec.rb +59 -0
- data/spec/models/api_request_logs_result_spec.rb +41 -0
- data/spec/models/app_store_product_spec.rb +47 -0
- data/spec/models/app_store_receipt_spec.rb +47 -0
- data/spec/models/approve_spec.rb +233 -0
- data/spec/models/attachment_spec.rb +77 -0
- data/spec/models/authentication_method_spec.rb +59 -0
- data/spec/models/authentication_status_spec.rb +137 -0
- data/spec/models/bcc_email_address_spec.rb +47 -0
- data/spec/models/billing_charge_response_spec.rb +41 -0
- data/spec/models/billing_charge_spec.rb +113 -0
- data/spec/models/billing_discount_spec.rb +53 -0
- data/spec/models/billing_invoice_item_spec.rb +65 -0
- data/spec/models/billing_invoice_spec.rb +95 -0
- data/spec/models/billing_invoices_response_spec.rb +53 -0
- data/spec/models/billing_invoices_summary_spec.rb +53 -0
- data/spec/models/billing_payment_item_spec.rb +65 -0
- data/spec/models/billing_payment_request_spec.rb +41 -0
- data/spec/models/billing_payment_response_spec.rb +41 -0
- data/spec/models/billing_payment_spec.rb +53 -0
- data/spec/models/billing_payments_response_spec.rb +53 -0
- data/spec/models/billing_plan_information_spec.rb +125 -0
- data/spec/models/billing_plan_preview_spec.rb +71 -0
- data/spec/models/billing_plan_response_spec.rb +47 -0
- data/spec/models/billing_plan_spec.rb +125 -0
- data/spec/models/billing_plan_update_response_spec.rb +77 -0
- data/spec/models/billing_plans_response_spec.rb +41 -0
- data/spec/models/billing_price_spec.rb +53 -0
- data/spec/models/brand_email_content_spec.rb +59 -0
- data/spec/models/brand_link_spec.rb +59 -0
- data/spec/models/brand_logos_spec.rb +53 -0
- data/spec/models/brand_request_spec.rb +41 -0
- data/spec/models/brand_resource_urls_spec.rb +59 -0
- data/spec/models/brand_resources_list_spec.rb +41 -0
- data/spec/models/brand_resources_spec.rb +77 -0
- data/spec/models/brand_spec.rb +113 -0
- data/spec/models/brands_request_spec.rb +41 -0
- data/spec/models/brands_response_spec.rb +53 -0
- data/spec/models/bulk_envelope_spec.rb +89 -0
- data/spec/models/bulk_envelope_status_spec.rb +119 -0
- data/spec/models/bulk_envelopes_response_spec.rb +77 -0
- data/spec/models/bulk_recipient_signature_provider_spec.rb +47 -0
- data/spec/models/bulk_recipient_spec.rb +95 -0
- data/spec/models/bulk_recipient_tab_label_spec.rb +47 -0
- data/spec/models/bulk_recipients_request_spec.rb +41 -0
- data/spec/models/bulk_recipients_response_spec.rb +77 -0
- data/spec/models/bulk_recipients_summary_response_spec.rb +59 -0
- data/spec/models/bulk_recipients_update_response_spec.rb +41 -0
- data/spec/models/captive_recipient_information_spec.rb +41 -0
- data/spec/models/captive_recipient_spec.rb +59 -0
- data/spec/models/carbon_copy_spec.rb +287 -0
- data/spec/models/certified_delivery_spec.rb +287 -0
- data/spec/models/checkbox_spec.rb +215 -0
- data/spec/models/chunked_upload_part_spec.rb +47 -0
- data/spec/models/chunked_upload_request_spec.rb +47 -0
- data/spec/models/chunked_upload_response_spec.rb +77 -0
- data/spec/models/cloud_storage_provider_spec.rb +65 -0
- data/spec/models/cloud_storage_providers_spec.rb +41 -0
- data/spec/models/company_spec.rb +269 -0
- data/spec/models/composite_template_spec.rb +65 -0
- data/spec/models/connect_config_results_spec.rb +47 -0
- data/spec/models/connect_custom_configuration_spec.rb +161 -0
- data/spec/models/connect_debug_log_spec.rb +65 -0
- data/spec/models/connect_failure_filter_spec.rb +47 -0
- data/spec/models/connect_failure_result_spec.rb +65 -0
- data/spec/models/connect_failure_results_spec.rb +41 -0
- data/spec/models/connect_log_spec.rb +143 -0
- data/spec/models/connect_logs_spec.rb +59 -0
- data/spec/models/console_view_request_spec.rb +47 -0
- data/spec/models/consumer_disclosure_spec.rb +215 -0
- data/spec/models/contact_get_response_spec.rb +77 -0
- data/spec/models/contact_mod_request_spec.rb +41 -0
- data/spec/models/contact_spec.rb +89 -0
- data/spec/models/contact_update_response_spec.rb +41 -0
- data/spec/models/correct_view_request_spec.rb +47 -0
- data/spec/models/country_spec.rb +59 -0
- data/spec/models/credit_card_information_spec.rb +71 -0
- data/spec/models/credit_card_types_spec.rb +41 -0
- data/spec/models/currency_feature_set_price_spec.rb +65 -0
- data/spec/models/currency_plan_price_spec.rb +71 -0
- data/spec/models/custom_field_v2_spec.rb +77 -0
- data/spec/models/custom_fields_envelope_spec.rb +47 -0
- data/spec/models/custom_fields_spec.rb +47 -0
- data/spec/models/custom_settings_information_spec.rb +41 -0
- data/spec/models/date_signed_spec.rb +227 -0
- data/spec/models/date_spec.rb +305 -0
- data/spec/models/decline_spec.rb +239 -0
- data/spec/models/diagnostics_settings_information_spec.rb +53 -0
- data/spec/models/dob_information_input_spec.rb +53 -0
- data/spec/models/document_fields_information_spec.rb +41 -0
- data/spec/models/document_spec.rb +155 -0
- data/spec/models/document_template_list_spec.rb +41 -0
- data/spec/models/document_template_spec.rb +65 -0
- data/spec/models/document_visibility_list_spec.rb +41 -0
- data/spec/models/document_visibility_spec.rb +65 -0
- data/spec/models/e_note_configuration_spec.rb +65 -0
- data/spec/models/editor_spec.rb +281 -0
- data/spec/models/email_address_spec.rb +221 -0
- data/spec/models/email_settings_spec.rb +53 -0
- data/spec/models/email_spec.rb +305 -0
- data/spec/models/envelope_attachment_spec.rb +71 -0
- data/spec/models/envelope_attachments_request_spec.rb +41 -0
- data/spec/models/envelope_attachments_result_spec.rb +41 -0
- data/spec/models/envelope_audit_event_response_spec.rb +41 -0
- data/spec/models/envelope_audit_event_spec.rb +41 -0
- data/spec/models/envelope_definition_spec.rb +371 -0
- data/spec/models/envelope_document_spec.rb +137 -0
- data/spec/models/envelope_documents_result_spec.rb +47 -0
- data/spec/models/envelope_event_spec.rb +47 -0
- data/spec/models/envelope_form_data_spec.rb +71 -0
- data/spec/models/envelope_id_spec.rb +221 -0
- data/spec/models/envelope_ids_request_spec.rb +47 -0
- data/spec/models/envelope_notification_request_spec.rb +53 -0
- data/spec/models/envelope_spec.rb +317 -0
- data/spec/models/envelope_summary_spec.rb +59 -0
- data/spec/models/envelope_template_definition_spec.rb +125 -0
- data/spec/models/envelope_template_result_spec.rb +401 -0
- data/spec/models/envelope_template_results_spec.rb +83 -0
- data/spec/models/envelope_template_spec.rb +329 -0
- data/spec/models/envelope_transaction_status_spec.rb +59 -0
- data/spec/models/envelope_update_summary_spec.rb +83 -0
- data/spec/models/envelopes_information_spec.rb +83 -0
- data/spec/models/error_details_spec.rb +47 -0
- data/spec/models/event_notification_spec.rb +125 -0
- data/spec/models/event_result_spec.rb +59 -0
- data/spec/models/expirations_spec.rb +53 -0
- data/spec/models/external_doc_service_error_details_spec.rb +53 -0
- data/spec/models/external_file_spec.rb +83 -0
- data/spec/models/external_folder_spec.rb +95 -0
- data/spec/models/feature_set_spec.rb +89 -0
- data/spec/models/file_type_list_spec.rb +41 -0
- data/spec/models/file_type_spec.rb +47 -0
- data/spec/models/filter_spec.rb +101 -0
- data/spec/models/first_name_spec.rb +221 -0
- data/spec/models/folder_item_response_spec.rb +77 -0
- data/spec/models/folder_item_spec.rb +161 -0
- data/spec/models/folder_item_v2_spec.rb +155 -0
- data/spec/models/folder_items_response_spec.rb +77 -0
- data/spec/models/folder_spec.rb +107 -0
- data/spec/models/folders_request_spec.rb +47 -0
- data/spec/models/folders_response_spec.rb +41 -0
- data/spec/models/forgotten_password_information_spec.rb +83 -0
- data/spec/models/formula_tab_spec.rb +329 -0
- data/spec/models/full_name_spec.rb +221 -0
- data/spec/models/group_information_spec.rb +77 -0
- data/spec/models/group_spec.rb +71 -0
- data/spec/models/id_check_information_input_spec.rb +59 -0
- data/spec/models/in_person_signer_spec.rb +365 -0
- data/spec/models/initial_here_spec.rb +197 -0
- data/spec/models/inline_template_spec.rb +65 -0
- data/spec/models/integrated_user_info_list_spec.rb +83 -0
- data/spec/models/intermediary_spec.rb +287 -0
- data/spec/models/last_name_spec.rb +221 -0
- data/spec/models/list_custom_field_spec.rb +83 -0
- data/spec/models/list_item_spec.rb +53 -0
- data/spec/models/list_spec.rb +269 -0
- data/spec/models/lock_information_spec.rb +83 -0
- data/spec/models/lock_request_spec.rb +65 -0
- data/spec/models/login_account_spec.rb +101 -0
- data/spec/models/login_information_spec.rb +47 -0
- data/spec/models/match_box_spec.rb +65 -0
- data/spec/models/member_group_shared_item_spec.rb +53 -0
- data/spec/models/member_shared_items_spec.rb +59 -0
- data/spec/models/merge_field_spec.rb +65 -0
- data/spec/models/mobile_notifier_configuration_information_spec.rb +41 -0
- data/spec/models/mobile_notifier_configuration_spec.rb +53 -0
- data/spec/models/money_spec.rb +53 -0
- data/spec/models/name_value_spec.rb +59 -0
- data/spec/models/new_account_definition_spec.rb +95 -0
- data/spec/models/new_account_summary_spec.rb +77 -0
- data/spec/models/new_user_spec.rb +95 -0
- data/spec/models/new_users_definition_spec.rb +41 -0
- data/spec/models/new_users_summary_spec.rb +41 -0
- data/spec/models/notary_host_spec.rb +275 -0
- data/spec/models/note_spec.rb +245 -0
- data/spec/models/notification_spec.rb +53 -0
- data/spec/models/number_spec.rb +317 -0
- data/spec/models/oauth_access_spec.rb +71 -0
- data/spec/models/offline_attributes_spec.rb +71 -0
- data/spec/models/page_images_spec.rb +77 -0
- data/spec/models/page_request_spec.rb +47 -0
- data/spec/models/page_spec.rb +83 -0
- data/spec/models/payment_details_spec.rb +65 -0
- data/spec/models/payment_line_item_spec.rb +59 -0
- data/spec/models/permission_profile_information_spec.rb +41 -0
- data/spec/models/permission_profile_spec.rb +77 -0
- data/spec/models/plan_information_spec.rb +71 -0
- data/spec/models/post_transactions_request_spec.rb +59 -0
- data/spec/models/post_transactions_response_spec.rb +47 -0
- data/spec/models/power_form_form_data_envelope_spec.rb +47 -0
- data/spec/models/power_form_form_data_recipient_spec.rb +59 -0
- data/spec/models/power_form_recipient_spec.rb +113 -0
- data/spec/models/power_form_senders_response_spec.rb +77 -0
- data/spec/models/power_form_spec.rb +179 -0
- data/spec/models/power_forms_form_data_response_spec.rb +41 -0
- data/spec/models/power_forms_request_spec.rb +41 -0
- data/spec/models/power_forms_response_spec.rb +77 -0
- data/spec/models/property_metadata_spec.rb +47 -0
- data/spec/models/province_spec.rb +47 -0
- data/spec/models/provisioning_information_spec.rb +77 -0
- data/spec/models/purchased_envelopes_information_spec.rb +89 -0
- data/spec/models/radio_group_spec.rb +89 -0
- data/spec/models/radio_spec.rb +143 -0
- data/spec/models/recipient_attachment_spec.rb +71 -0
- data/spec/models/recipient_domain_spec.rb +59 -0
- data/spec/models/recipient_email_notification_spec.rb +53 -0
- data/spec/models/recipient_event_spec.rb +47 -0
- data/spec/models/recipient_form_data_spec.rb +83 -0
- data/spec/models/recipient_names_response_spec.rb +53 -0
- data/spec/models/recipient_phone_authentication_spec.rb +59 -0
- data/spec/models/recipient_saml_authentication_spec.rb +41 -0
- data/spec/models/recipient_signature_information_spec.rb +53 -0
- data/spec/models/recipient_signature_provider_options_spec.rb +59 -0
- data/spec/models/recipient_signature_provider_spec.rb +47 -0
- data/spec/models/recipient_sms_authentication_spec.rb +41 -0
- data/spec/models/recipient_update_response_spec.rb +53 -0
- data/spec/models/recipient_view_request_spec.rb +119 -0
- data/spec/models/recipients_spec.rb +95 -0
- data/spec/models/recipients_update_summary_spec.rb +41 -0
- data/spec/models/referral_information_spec.rb +143 -0
- data/spec/models/reminders_spec.rb +53 -0
- data/spec/models/resource_information_spec.rb +41 -0
- data/spec/models/return_url_request_spec.rb +41 -0
- data/spec/models/saml_assertion_attribute_spec.rb +59 -0
- data/spec/models/seat_discount_spec.rb +53 -0
- data/spec/models/sender_email_notifications_spec.rb +77 -0
- data/spec/models/server_template_spec.rb +47 -0
- data/spec/models/service_information_spec.rb +71 -0
- data/spec/models/service_version_spec.rb +47 -0
- data/spec/models/settings_metadata_spec.rb +71 -0
- data/spec/models/shared_item_spec.rb +53 -0
- data/spec/models/sign_here_spec.rb +197 -0
- data/spec/models/signature_provider_required_option_spec.rb +47 -0
- data/spec/models/signature_type_spec.rb +47 -0
- data/spec/models/signer_attachment_spec.rb +197 -0
- data/spec/models/signer_email_notifications_spec.rb +119 -0
- data/spec/models/signer_spec.rb +371 -0
- data/spec/models/signing_group_information_spec.rb +41 -0
- data/spec/models/signing_group_spec.rb +95 -0
- data/spec/models/signing_group_user_spec.rb +53 -0
- data/spec/models/signing_group_users_spec.rb +41 -0
- data/spec/models/social_account_information_spec.rb +65 -0
- data/spec/models/social_authentication_spec.rb +41 -0
- data/spec/models/ssn4_information_input_spec.rb +53 -0
- data/spec/models/ssn9_information_input_spec.rb +47 -0
- data/spec/models/ssn_spec.rb +305 -0
- data/spec/models/tab_account_settings_spec.rb +263 -0
- data/spec/models/tab_metadata_list_spec.rb +41 -0
- data/spec/models/tab_metadata_spec.rb +269 -0
- data/spec/models/tabs_spec.rb +185 -0
- data/spec/models/template_custom_fields_spec.rb +47 -0
- data/spec/models/template_document_visibility_list_spec.rb +41 -0
- data/spec/models/template_documents_result_spec.rb +47 -0
- data/spec/models/template_information_spec.rb +41 -0
- data/spec/models/template_match_spec.rb +53 -0
- data/spec/models/template_notification_request_spec.rb +59 -0
- data/spec/models/template_recipients_spec.rb +95 -0
- data/spec/models/template_role_spec.rb +107 -0
- data/spec/models/template_shared_item_spec.rb +77 -0
- data/spec/models/template_summary_spec.rb +77 -0
- data/spec/models/template_tabs_spec.rb +185 -0
- data/spec/models/template_update_summary_spec.rb +83 -0
- data/spec/models/text_custom_field_spec.rb +77 -0
- data/spec/models/text_spec.rb +323 -0
- data/spec/models/title_spec.rb +269 -0
- data/spec/models/usage_history_spec.rb +59 -0
- data/spec/models/user_account_management_granular_information_spec.rb +83 -0
- data/spec/models/user_info_list_spec.rb +41 -0
- data/spec/models/user_info_spec.rb +95 -0
- data/spec/models/user_information_list_spec.rb +77 -0
- data/spec/models/user_information_spec.rb +239 -0
- data/spec/models/user_password_information_spec.rb +59 -0
- data/spec/models/user_profile_spec.rb +107 -0
- data/spec/models/user_settings_information_spec.rb +59 -0
- data/spec/models/user_shared_item_spec.rb +53 -0
- data/spec/models/user_signature_definition_spec.rb +59 -0
- data/spec/models/user_signature_spec.rb +113 -0
- data/spec/models/user_signatures_information_spec.rb +41 -0
- data/spec/models/user_social_id_result_spec.rb +47 -0
- data/spec/models/users_response_spec.rb +77 -0
- data/spec/models/view_link_request_spec.rb +47 -0
- data/spec/models/view_spec.rb +245 -0
- data/spec/models/view_url_spec.rb +41 -0
- data/spec/models/workspace_folder_contents_spec.rb +83 -0
- data/spec/models/workspace_item_list_spec.rb +41 -0
- data/spec/models/workspace_item_spec.rb +149 -0
- data/spec/models/workspace_list_spec.rb +65 -0
- data/spec/models/workspace_spec.rb +101 -0
- data/spec/models/workspace_user_authorization_spec.rb +101 -0
- data/spec/models/workspace_user_spec.rb +131 -0
- data/spec/models/zip_spec.rb +311 -0
- data/spec/spec_helper.rb +110 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile +5 -0
- data/tests/Gemfile.lock +42 -0
- data/tests/docs/Test.pdf +0 -0
- data/tests/rsa_keys/private.pem +27 -0
- data/tests/rsa_keys/public.pem +9 -0
- data/tests/spec/unit_tests_spec.rb +360 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +361 -0
- metadata +1560 -0
@@ -0,0 +1,2555 @@
|
|
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 CreateRecipientsOptions
|
17
|
+
#
|
18
|
+
attr_accessor :resend_envelope
|
19
|
+
|
20
|
+
def self.default
|
21
|
+
@@default ||= CreateRecipientsOptions.new
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
class GetOptions
|
26
|
+
#
|
27
|
+
attr_accessor :include
|
28
|
+
|
29
|
+
def self.default
|
30
|
+
@@default ||= GetOptions.new
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
class GetDocumentOptions
|
35
|
+
#
|
36
|
+
attr_accessor :encrypt
|
37
|
+
|
38
|
+
#
|
39
|
+
attr_accessor :show_changes
|
40
|
+
|
41
|
+
def self.default
|
42
|
+
@@default ||= GetDocumentOptions.new
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
class GetDocumentPageImageOptions
|
47
|
+
#
|
48
|
+
attr_accessor :dpi
|
49
|
+
|
50
|
+
#
|
51
|
+
attr_accessor :max_height
|
52
|
+
|
53
|
+
#
|
54
|
+
attr_accessor :max_width
|
55
|
+
|
56
|
+
#
|
57
|
+
attr_accessor :show_changes
|
58
|
+
|
59
|
+
def self.default
|
60
|
+
@@default ||= GetDocumentPageImageOptions.new
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
class ListBulkRecipientsOptions
|
65
|
+
#
|
66
|
+
attr_accessor :include_tabs
|
67
|
+
|
68
|
+
#
|
69
|
+
attr_accessor :start_position
|
70
|
+
|
71
|
+
def self.default
|
72
|
+
@@default ||= ListBulkRecipientsOptions.new
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
class ListRecipientsOptions
|
77
|
+
# When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response.
|
78
|
+
attr_accessor :include_anchor_tab_locations
|
79
|
+
|
80
|
+
# When set to **true**, the extended properties are included in the response.
|
81
|
+
attr_accessor :include_extended
|
82
|
+
|
83
|
+
# When set to **true**, the tab information associated with the recipient is included in the response.
|
84
|
+
attr_accessor :include_tabs
|
85
|
+
|
86
|
+
def self.default
|
87
|
+
@@default ||= ListRecipientsOptions.new
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
class ListTabsOptions
|
92
|
+
# When set to **true**, all tabs with anchor tab properties are included in the response.
|
93
|
+
attr_accessor :include_anchor_tab_locations
|
94
|
+
|
95
|
+
#
|
96
|
+
attr_accessor :include_metadata
|
97
|
+
|
98
|
+
def self.default
|
99
|
+
@@default ||= ListTabsOptions.new
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
class ListTemplatesOptions
|
104
|
+
# Number of records to return in the cache.
|
105
|
+
attr_accessor :count
|
106
|
+
|
107
|
+
# The query value can be a folder name or folder ID. The response will only return templates in the specified folder.
|
108
|
+
attr_accessor :folder
|
109
|
+
|
110
|
+
# A comma separated list of folder ID GUIDs.
|
111
|
+
attr_accessor :folder_ids
|
112
|
+
|
113
|
+
# Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
|
114
|
+
attr_accessor :from_date
|
115
|
+
|
116
|
+
# A comma separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
|
117
|
+
attr_accessor :include
|
118
|
+
|
119
|
+
# Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a)
|
120
|
+
attr_accessor :order
|
121
|
+
|
122
|
+
# Sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used.
|
123
|
+
attr_accessor :order_by
|
124
|
+
|
125
|
+
# The search text used to search the names of templates.
|
126
|
+
attr_accessor :search_text
|
127
|
+
|
128
|
+
#
|
129
|
+
attr_accessor :shared
|
130
|
+
|
131
|
+
# If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.
|
132
|
+
attr_accessor :shared_by_me
|
133
|
+
|
134
|
+
# The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).
|
135
|
+
attr_accessor :start_position
|
136
|
+
|
137
|
+
# End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.
|
138
|
+
attr_accessor :to_date
|
139
|
+
|
140
|
+
# Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.
|
141
|
+
attr_accessor :used_from_date
|
142
|
+
|
143
|
+
# End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.
|
144
|
+
attr_accessor :used_to_date
|
145
|
+
|
146
|
+
# Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user.
|
147
|
+
attr_accessor :user_filter
|
148
|
+
|
149
|
+
def self.default
|
150
|
+
@@default ||= ListTemplatesOptions.new
|
151
|
+
end
|
152
|
+
end
|
153
|
+
|
154
|
+
class UpdateDocumentOptions
|
155
|
+
#
|
156
|
+
attr_accessor :apply_document_fields
|
157
|
+
|
158
|
+
#
|
159
|
+
attr_accessor :is_envelope_definition
|
160
|
+
|
161
|
+
def self.default
|
162
|
+
@@default ||= UpdateDocumentOptions.new
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
class UpdateDocumentsOptions
|
167
|
+
#
|
168
|
+
attr_accessor :apply_document_fields
|
169
|
+
|
170
|
+
def self.default
|
171
|
+
@@default ||= UpdateDocumentsOptions.new
|
172
|
+
end
|
173
|
+
end
|
174
|
+
|
175
|
+
class UpdateRecipientsOptions
|
176
|
+
#
|
177
|
+
attr_accessor :resend_envelope
|
178
|
+
|
179
|
+
def self.default
|
180
|
+
@@default ||= UpdateRecipientsOptions.new
|
181
|
+
end
|
182
|
+
end
|
183
|
+
|
184
|
+
|
185
|
+
class TemplatesApi
|
186
|
+
attr_accessor :api_client
|
187
|
+
|
188
|
+
def initialize(api_client = TemplatesApi.default)
|
189
|
+
@api_client = api_client
|
190
|
+
end
|
191
|
+
|
192
|
+
# Creates custom document fields in an existing template document.
|
193
|
+
# Creates custom document fields in an existing template document.
|
194
|
+
# @param account_id The external account number (int) or account ID Guid.
|
195
|
+
# @param template_id The ID of the template being accessed.
|
196
|
+
# @param template_custom_fields (optional parameter)
|
197
|
+
# @return [CustomFields]
|
198
|
+
def create_custom_fields(account_id, template_id, template_custom_fields)
|
199
|
+
data, _status_code, _headers = create_custom_fields_with_http_info(account_id, template_id, template_custom_fields)
|
200
|
+
return data
|
201
|
+
end
|
202
|
+
|
203
|
+
# Creates custom document fields in an existing template document.
|
204
|
+
# Creates custom document fields in an existing template document.
|
205
|
+
# @param account_id The external account number (int) or account ID Guid.
|
206
|
+
# @param template_id The ID of the template being accessed.
|
207
|
+
# @param template_custom_fields (optional parameter)
|
208
|
+
# @return [Array<(CustomFields, Fixnum, Hash)>] CustomFields data, response status code and response headers
|
209
|
+
def create_custom_fields_with_http_info(account_id, template_id, template_custom_fields)
|
210
|
+
if @api_client.config.debugging
|
211
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.create_custom_fields ..."
|
212
|
+
end
|
213
|
+
# verify the required parameter 'account_id' is set
|
214
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_custom_fields" if account_id.nil?
|
215
|
+
# verify the required parameter 'template_id' is set
|
216
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_custom_fields" if template_id.nil?
|
217
|
+
# resource path
|
218
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
219
|
+
|
220
|
+
# query parameters
|
221
|
+
query_params = {}
|
222
|
+
|
223
|
+
# header parameters
|
224
|
+
header_params = {}
|
225
|
+
# HTTP header 'Accept' (if needed)
|
226
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
227
|
+
|
228
|
+
# form parameters
|
229
|
+
form_params = {}
|
230
|
+
|
231
|
+
# http body (model)
|
232
|
+
post_body = @api_client.object_to_http_body(template_custom_fields)
|
233
|
+
auth_names = []
|
234
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
235
|
+
:header_params => header_params,
|
236
|
+
:query_params => query_params,
|
237
|
+
:form_params => form_params,
|
238
|
+
:body => post_body,
|
239
|
+
:auth_names => auth_names,
|
240
|
+
:return_type => 'CustomFields')
|
241
|
+
if @api_client.config.debugging
|
242
|
+
@api_client.config.logger.debug "API called: TemplatesApi#create_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
243
|
+
end
|
244
|
+
return data, status_code, headers
|
245
|
+
end
|
246
|
+
|
247
|
+
# Creates custom document fields in an existing template document.
|
248
|
+
# Creates custom document fields in an existing template document.
|
249
|
+
# @param account_id The external account number (int) or account ID Guid.
|
250
|
+
# @param document_id The ID of the document being accessed.
|
251
|
+
# @param template_id The ID of the template being accessed.
|
252
|
+
# @param document_fields_information (optional parameter)
|
253
|
+
# @return [DocumentFieldsInformation]
|
254
|
+
def create_document_fields(account_id, document_id, template_id, document_fields_information)
|
255
|
+
data, _status_code, _headers = create_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information)
|
256
|
+
return data
|
257
|
+
end
|
258
|
+
|
259
|
+
# Creates custom document fields in an existing template document.
|
260
|
+
# Creates custom document fields in an existing template document.
|
261
|
+
# @param account_id The external account number (int) or account ID Guid.
|
262
|
+
# @param document_id The ID of the document being accessed.
|
263
|
+
# @param template_id The ID of the template being accessed.
|
264
|
+
# @param document_fields_information (optional parameter)
|
265
|
+
# @return [Array<(DocumentFieldsInformation, Fixnum, Hash)>] DocumentFieldsInformation data, response status code and response headers
|
266
|
+
def create_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information)
|
267
|
+
if @api_client.config.debugging
|
268
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.create_document_fields ..."
|
269
|
+
end
|
270
|
+
# verify the required parameter 'account_id' is set
|
271
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_document_fields" if account_id.nil?
|
272
|
+
# verify the required parameter 'document_id' is set
|
273
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.create_document_fields" if document_id.nil?
|
274
|
+
# verify the required parameter 'template_id' is set
|
275
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_document_fields" if template_id.nil?
|
276
|
+
# resource path
|
277
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
278
|
+
|
279
|
+
# query parameters
|
280
|
+
query_params = {}
|
281
|
+
|
282
|
+
# header parameters
|
283
|
+
header_params = {}
|
284
|
+
# HTTP header 'Accept' (if needed)
|
285
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
286
|
+
|
287
|
+
# form parameters
|
288
|
+
form_params = {}
|
289
|
+
|
290
|
+
# http body (model)
|
291
|
+
post_body = @api_client.object_to_http_body(document_fields_information)
|
292
|
+
auth_names = []
|
293
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
294
|
+
:header_params => header_params,
|
295
|
+
:query_params => query_params,
|
296
|
+
:form_params => form_params,
|
297
|
+
:body => post_body,
|
298
|
+
:auth_names => auth_names,
|
299
|
+
:return_type => 'DocumentFieldsInformation')
|
300
|
+
if @api_client.config.debugging
|
301
|
+
@api_client.config.logger.debug "API called: TemplatesApi#create_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
302
|
+
end
|
303
|
+
return data, status_code, headers
|
304
|
+
end
|
305
|
+
|
306
|
+
# Provides a URL to start an edit view of the Template UI
|
307
|
+
#
|
308
|
+
# @param account_id The external account number (int) or account ID Guid.
|
309
|
+
# @param template_id The ID of the template being accessed.
|
310
|
+
# @param return_url_request (optional parameter)
|
311
|
+
# @return [ViewUrl]
|
312
|
+
def create_edit_view(account_id, template_id, return_url_request)
|
313
|
+
data, _status_code, _headers = create_edit_view_with_http_info(account_id, template_id, return_url_request)
|
314
|
+
return data
|
315
|
+
end
|
316
|
+
|
317
|
+
# Provides a URL to start an edit view of the Template UI
|
318
|
+
#
|
319
|
+
# @param account_id The external account number (int) or account ID Guid.
|
320
|
+
# @param template_id The ID of the template being accessed.
|
321
|
+
# @param return_url_request (optional parameter)
|
322
|
+
# @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
|
323
|
+
def create_edit_view_with_http_info(account_id, template_id, return_url_request)
|
324
|
+
if @api_client.config.debugging
|
325
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.create_edit_view ..."
|
326
|
+
end
|
327
|
+
# verify the required parameter 'account_id' is set
|
328
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_edit_view" if account_id.nil?
|
329
|
+
# verify the required parameter 'template_id' is set
|
330
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_edit_view" if template_id.nil?
|
331
|
+
# resource path
|
332
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/views/edit".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
333
|
+
|
334
|
+
# query parameters
|
335
|
+
query_params = {}
|
336
|
+
|
337
|
+
# header parameters
|
338
|
+
header_params = {}
|
339
|
+
# HTTP header 'Accept' (if needed)
|
340
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
341
|
+
|
342
|
+
# form parameters
|
343
|
+
form_params = {}
|
344
|
+
|
345
|
+
# http body (model)
|
346
|
+
post_body = @api_client.object_to_http_body(return_url_request)
|
347
|
+
auth_names = []
|
348
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
349
|
+
:header_params => header_params,
|
350
|
+
:query_params => query_params,
|
351
|
+
:form_params => form_params,
|
352
|
+
:body => post_body,
|
353
|
+
:auth_names => auth_names,
|
354
|
+
:return_type => 'ViewUrl')
|
355
|
+
if @api_client.config.debugging
|
356
|
+
@api_client.config.logger.debug "API called: TemplatesApi#create_edit_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
357
|
+
end
|
358
|
+
return data, status_code, headers
|
359
|
+
end
|
360
|
+
|
361
|
+
# Lock a template.
|
362
|
+
# Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to **true** for the user).
|
363
|
+
# @param account_id The external account number (int) or account ID Guid.
|
364
|
+
# @param template_id The ID of the template being accessed.
|
365
|
+
# @param lock_request (optional parameter)
|
366
|
+
# @return [LockInformation]
|
367
|
+
def create_lock(account_id, template_id, lock_request)
|
368
|
+
data, _status_code, _headers = create_lock_with_http_info(account_id, template_id, lock_request)
|
369
|
+
return data
|
370
|
+
end
|
371
|
+
|
372
|
+
# Lock a template.
|
373
|
+
# Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template. ###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to **true** for the user).
|
374
|
+
# @param account_id The external account number (int) or account ID Guid.
|
375
|
+
# @param template_id The ID of the template being accessed.
|
376
|
+
# @param lock_request (optional parameter)
|
377
|
+
# @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
|
378
|
+
def create_lock_with_http_info(account_id, template_id, lock_request)
|
379
|
+
if @api_client.config.debugging
|
380
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.create_lock ..."
|
381
|
+
end
|
382
|
+
# verify the required parameter 'account_id' is set
|
383
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_lock" if account_id.nil?
|
384
|
+
# verify the required parameter 'template_id' is set
|
385
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_lock" if template_id.nil?
|
386
|
+
# resource path
|
387
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
388
|
+
|
389
|
+
# query parameters
|
390
|
+
query_params = {}
|
391
|
+
|
392
|
+
# header parameters
|
393
|
+
header_params = {}
|
394
|
+
# HTTP header 'Accept' (if needed)
|
395
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
396
|
+
|
397
|
+
# form parameters
|
398
|
+
form_params = {}
|
399
|
+
|
400
|
+
# http body (model)
|
401
|
+
post_body = @api_client.object_to_http_body(lock_request)
|
402
|
+
auth_names = []
|
403
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
404
|
+
:header_params => header_params,
|
405
|
+
:query_params => query_params,
|
406
|
+
:form_params => form_params,
|
407
|
+
:body => post_body,
|
408
|
+
:auth_names => auth_names,
|
409
|
+
:return_type => 'LockInformation')
|
410
|
+
if @api_client.config.debugging
|
411
|
+
@api_client.config.logger.debug "API called: TemplatesApi#create_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
412
|
+
end
|
413
|
+
return data, status_code, headers
|
414
|
+
end
|
415
|
+
|
416
|
+
# Adds tabs for a recipient.
|
417
|
+
# Adds one or more recipients to a template.
|
418
|
+
# @param account_id The external account number (int) or account ID Guid.
|
419
|
+
# @param template_id The ID of the template being accessed.
|
420
|
+
# @param template_recipients (optional parameter)
|
421
|
+
# @param DocuSign_eSign::CreateRecipientsOptions Options for modifying the behavior of the function.
|
422
|
+
# @return [Recipients]
|
423
|
+
def create_recipients(account_id, template_id, template_recipients, options = DocuSign_eSign::CreateRecipientsOptions.default)
|
424
|
+
data, _status_code, _headers = create_recipients_with_http_info(account_id, template_id, template_recipients, options)
|
425
|
+
return data
|
426
|
+
end
|
427
|
+
|
428
|
+
# Adds tabs for a recipient.
|
429
|
+
# Adds one or more recipients to a template.
|
430
|
+
# @param account_id The external account number (int) or account ID Guid.
|
431
|
+
# @param template_id The ID of the template being accessed.
|
432
|
+
# @param template_recipients (optional parameter)
|
433
|
+
# @param DocuSign_eSign::CreateRecipientsOptions Options for modifying the behavior of the function.
|
434
|
+
# @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
|
435
|
+
def create_recipients_with_http_info(account_id, template_id, template_recipients, options = DocuSign_eSign::CreateRecipientsOptions.default)
|
436
|
+
if @api_client.config.debugging
|
437
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.create_recipients ..."
|
438
|
+
end
|
439
|
+
# verify the required parameter 'account_id' is set
|
440
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_recipients" if account_id.nil?
|
441
|
+
# verify the required parameter 'template_id' is set
|
442
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_recipients" if template_id.nil?
|
443
|
+
# resource path
|
444
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
445
|
+
|
446
|
+
# query parameters
|
447
|
+
query_params = {}
|
448
|
+
query_params[:'resend_envelope'] = options.resend_envelope if !options.resend_envelope.nil?
|
449
|
+
|
450
|
+
# header parameters
|
451
|
+
header_params = {}
|
452
|
+
# HTTP header 'Accept' (if needed)
|
453
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
454
|
+
|
455
|
+
# form parameters
|
456
|
+
form_params = {}
|
457
|
+
|
458
|
+
# http body (model)
|
459
|
+
post_body = @api_client.object_to_http_body(template_recipients)
|
460
|
+
auth_names = []
|
461
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
462
|
+
:header_params => header_params,
|
463
|
+
:query_params => query_params,
|
464
|
+
:form_params => form_params,
|
465
|
+
:body => post_body,
|
466
|
+
:auth_names => auth_names,
|
467
|
+
:return_type => 'Recipients')
|
468
|
+
if @api_client.config.debugging
|
469
|
+
@api_client.config.logger.debug "API called: TemplatesApi#create_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
470
|
+
end
|
471
|
+
return data, status_code, headers
|
472
|
+
end
|
473
|
+
|
474
|
+
# Adds tabs for a recipient.
|
475
|
+
# Adds one or more tabs for a recipient.
|
476
|
+
# @param account_id The external account number (int) or account ID Guid.
|
477
|
+
# @param recipient_id The ID of the recipient being accessed.
|
478
|
+
# @param template_id The ID of the template being accessed.
|
479
|
+
# @param template_tabs (optional parameter)
|
480
|
+
# @return [Tabs]
|
481
|
+
def create_tabs(account_id, recipient_id, template_id, template_tabs)
|
482
|
+
data, _status_code, _headers = create_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs)
|
483
|
+
return data
|
484
|
+
end
|
485
|
+
|
486
|
+
# Adds tabs for a recipient.
|
487
|
+
# Adds one or more tabs for a recipient.
|
488
|
+
# @param account_id The external account number (int) or account ID Guid.
|
489
|
+
# @param recipient_id The ID of the recipient being accessed.
|
490
|
+
# @param template_id The ID of the template being accessed.
|
491
|
+
# @param template_tabs (optional parameter)
|
492
|
+
# @return [Array<(Tabs, Fixnum, Hash)>] Tabs data, response status code and response headers
|
493
|
+
def create_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs)
|
494
|
+
if @api_client.config.debugging
|
495
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.create_tabs ..."
|
496
|
+
end
|
497
|
+
# verify the required parameter 'account_id' is set
|
498
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_tabs" if account_id.nil?
|
499
|
+
# verify the required parameter 'recipient_id' is set
|
500
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.create_tabs" if recipient_id.nil?
|
501
|
+
# verify the required parameter 'template_id' is set
|
502
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.create_tabs" if template_id.nil?
|
503
|
+
# resource path
|
504
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
505
|
+
|
506
|
+
# query parameters
|
507
|
+
query_params = {}
|
508
|
+
|
509
|
+
# header parameters
|
510
|
+
header_params = {}
|
511
|
+
# HTTP header 'Accept' (if needed)
|
512
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
513
|
+
|
514
|
+
# form parameters
|
515
|
+
form_params = {}
|
516
|
+
|
517
|
+
# http body (model)
|
518
|
+
post_body = @api_client.object_to_http_body(template_tabs)
|
519
|
+
auth_names = []
|
520
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
521
|
+
:header_params => header_params,
|
522
|
+
:query_params => query_params,
|
523
|
+
:form_params => form_params,
|
524
|
+
:body => post_body,
|
525
|
+
:auth_names => auth_names,
|
526
|
+
:return_type => 'Tabs')
|
527
|
+
if @api_client.config.debugging
|
528
|
+
@api_client.config.logger.debug "API called: TemplatesApi#create_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
529
|
+
end
|
530
|
+
return data, status_code, headers
|
531
|
+
end
|
532
|
+
|
533
|
+
# Creates an envelope from a template.
|
534
|
+
# Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient’s role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient’s name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",` To add a recipient’s email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.
|
535
|
+
# @param account_id The external account number (int) or account ID Guid.
|
536
|
+
# @param envelope_template (optional parameter)
|
537
|
+
# @return [TemplateSummary]
|
538
|
+
def create_template(account_id, envelope_template)
|
539
|
+
data, _status_code, _headers = create_template_with_http_info(account_id, envelope_template)
|
540
|
+
return data
|
541
|
+
end
|
542
|
+
|
543
|
+
# Creates an envelope from a template.
|
544
|
+
# Creates a template definition using a multipart request. ###Template Email Subject Merge Fields Call this endpoint to insert a recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient’s role name, are added to the `emailSubject` property when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. ###### Note: If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. To add a recipient’s name in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",` To add a recipient’s email address in the subject line add the following text in the `emailSubject` property when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",` In both cases the <roleName> is the recipient's contents of the `roleName` property in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.
|
545
|
+
# @param account_id The external account number (int) or account ID Guid.
|
546
|
+
# @param envelope_template (optional parameter)
|
547
|
+
# @return [Array<(TemplateSummary, Fixnum, Hash)>] TemplateSummary data, response status code and response headers
|
548
|
+
def create_template_with_http_info(account_id, envelope_template)
|
549
|
+
if @api_client.config.debugging
|
550
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.create_template ..."
|
551
|
+
end
|
552
|
+
# verify the required parameter 'account_id' is set
|
553
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.create_template" if account_id.nil?
|
554
|
+
# resource path
|
555
|
+
local_var_path = "/v2/accounts/{accountId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
556
|
+
|
557
|
+
# query parameters
|
558
|
+
query_params = {}
|
559
|
+
|
560
|
+
# header parameters
|
561
|
+
header_params = {}
|
562
|
+
# HTTP header 'Accept' (if needed)
|
563
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
564
|
+
|
565
|
+
# form parameters
|
566
|
+
form_params = {}
|
567
|
+
|
568
|
+
# http body (model)
|
569
|
+
post_body = @api_client.object_to_http_body(envelope_template)
|
570
|
+
auth_names = []
|
571
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
572
|
+
:header_params => header_params,
|
573
|
+
:query_params => query_params,
|
574
|
+
:form_params => form_params,
|
575
|
+
:body => post_body,
|
576
|
+
:auth_names => auth_names,
|
577
|
+
:return_type => 'TemplateSummary')
|
578
|
+
if @api_client.config.debugging
|
579
|
+
@api_client.config.logger.debug "API called: TemplatesApi#create_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
580
|
+
end
|
581
|
+
return data, status_code, headers
|
582
|
+
end
|
583
|
+
|
584
|
+
# Deletes the bulk recipient list on a template.
|
585
|
+
# Deletes the bulk recipient list on a template.
|
586
|
+
# @param account_id The external account number (int) or account ID Guid.
|
587
|
+
# @param recipient_id The ID of the recipient being accessed.
|
588
|
+
# @param template_id The ID of the template being accessed.
|
589
|
+
# @return [BulkRecipientsUpdateResponse]
|
590
|
+
def delete_bulk_recipients(account_id, recipient_id, template_id)
|
591
|
+
data, _status_code, _headers = delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id)
|
592
|
+
return data
|
593
|
+
end
|
594
|
+
|
595
|
+
# Deletes the bulk recipient list on a template.
|
596
|
+
# Deletes the bulk recipient list on a template.
|
597
|
+
# @param account_id The external account number (int) or account ID Guid.
|
598
|
+
# @param recipient_id The ID of the recipient being accessed.
|
599
|
+
# @param template_id The ID of the template being accessed.
|
600
|
+
# @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
|
601
|
+
def delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id)
|
602
|
+
if @api_client.config.debugging
|
603
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_bulk_recipients ..."
|
604
|
+
end
|
605
|
+
# verify the required parameter 'account_id' is set
|
606
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_bulk_recipients" if account_id.nil?
|
607
|
+
# verify the required parameter 'recipient_id' is set
|
608
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.delete_bulk_recipients" if recipient_id.nil?
|
609
|
+
# verify the required parameter 'template_id' is set
|
610
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_bulk_recipients" if template_id.nil?
|
611
|
+
# resource path
|
612
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
613
|
+
|
614
|
+
# query parameters
|
615
|
+
query_params = {}
|
616
|
+
|
617
|
+
# header parameters
|
618
|
+
header_params = {}
|
619
|
+
# HTTP header 'Accept' (if needed)
|
620
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
621
|
+
|
622
|
+
# form parameters
|
623
|
+
form_params = {}
|
624
|
+
|
625
|
+
# http body (model)
|
626
|
+
post_body = nil
|
627
|
+
auth_names = []
|
628
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
629
|
+
:header_params => header_params,
|
630
|
+
:query_params => query_params,
|
631
|
+
:form_params => form_params,
|
632
|
+
:body => post_body,
|
633
|
+
:auth_names => auth_names,
|
634
|
+
:return_type => 'BulkRecipientsUpdateResponse')
|
635
|
+
if @api_client.config.debugging
|
636
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
637
|
+
end
|
638
|
+
return data, status_code, headers
|
639
|
+
end
|
640
|
+
|
641
|
+
# Deletes envelope custom fields in a template.
|
642
|
+
# Deletes envelope custom fields in a template.
|
643
|
+
# @param account_id The external account number (int) or account ID Guid.
|
644
|
+
# @param template_id The ID of the template being accessed.
|
645
|
+
# @param template_custom_fields (optional parameter)
|
646
|
+
# @return [CustomFields]
|
647
|
+
def delete_custom_fields(account_id, template_id, template_custom_fields)
|
648
|
+
data, _status_code, _headers = delete_custom_fields_with_http_info(account_id, template_id, template_custom_fields)
|
649
|
+
return data
|
650
|
+
end
|
651
|
+
|
652
|
+
# Deletes envelope custom fields in a template.
|
653
|
+
# Deletes envelope custom fields in a template.
|
654
|
+
# @param account_id The external account number (int) or account ID Guid.
|
655
|
+
# @param template_id The ID of the template being accessed.
|
656
|
+
# @param template_custom_fields (optional parameter)
|
657
|
+
# @return [Array<(CustomFields, Fixnum, Hash)>] CustomFields data, response status code and response headers
|
658
|
+
def delete_custom_fields_with_http_info(account_id, template_id, template_custom_fields)
|
659
|
+
if @api_client.config.debugging
|
660
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_custom_fields ..."
|
661
|
+
end
|
662
|
+
# verify the required parameter 'account_id' is set
|
663
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_custom_fields" if account_id.nil?
|
664
|
+
# verify the required parameter 'template_id' is set
|
665
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_custom_fields" if template_id.nil?
|
666
|
+
# resource path
|
667
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
668
|
+
|
669
|
+
# query parameters
|
670
|
+
query_params = {}
|
671
|
+
|
672
|
+
# header parameters
|
673
|
+
header_params = {}
|
674
|
+
# HTTP header 'Accept' (if needed)
|
675
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
676
|
+
|
677
|
+
# form parameters
|
678
|
+
form_params = {}
|
679
|
+
|
680
|
+
# http body (model)
|
681
|
+
post_body = @api_client.object_to_http_body(template_custom_fields)
|
682
|
+
auth_names = []
|
683
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
684
|
+
:header_params => header_params,
|
685
|
+
:query_params => query_params,
|
686
|
+
:form_params => form_params,
|
687
|
+
:body => post_body,
|
688
|
+
:auth_names => auth_names,
|
689
|
+
:return_type => 'CustomFields')
|
690
|
+
if @api_client.config.debugging
|
691
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
692
|
+
end
|
693
|
+
return data, status_code, headers
|
694
|
+
end
|
695
|
+
|
696
|
+
# Deletes custom document fields from an existing template document.
|
697
|
+
# Deletes custom document fields from an existing template document.
|
698
|
+
# @param account_id The external account number (int) or account ID Guid.
|
699
|
+
# @param document_id The ID of the document being accessed.
|
700
|
+
# @param template_id The ID of the template being accessed.
|
701
|
+
# @param document_fields_information (optional parameter)
|
702
|
+
# @return [DocumentFieldsInformation]
|
703
|
+
def delete_document_fields(account_id, document_id, template_id, document_fields_information)
|
704
|
+
data, _status_code, _headers = delete_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information)
|
705
|
+
return data
|
706
|
+
end
|
707
|
+
|
708
|
+
# Deletes custom document fields from an existing template document.
|
709
|
+
# Deletes custom document fields from an existing template document.
|
710
|
+
# @param account_id The external account number (int) or account ID Guid.
|
711
|
+
# @param document_id The ID of the document being accessed.
|
712
|
+
# @param template_id The ID of the template being accessed.
|
713
|
+
# @param document_fields_information (optional parameter)
|
714
|
+
# @return [Array<(DocumentFieldsInformation, Fixnum, Hash)>] DocumentFieldsInformation data, response status code and response headers
|
715
|
+
def delete_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information)
|
716
|
+
if @api_client.config.debugging
|
717
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_document_fields ..."
|
718
|
+
end
|
719
|
+
# verify the required parameter 'account_id' is set
|
720
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_document_fields" if account_id.nil?
|
721
|
+
# verify the required parameter 'document_id' is set
|
722
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.delete_document_fields" if document_id.nil?
|
723
|
+
# verify the required parameter 'template_id' is set
|
724
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_document_fields" if template_id.nil?
|
725
|
+
# resource path
|
726
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
727
|
+
|
728
|
+
# query parameters
|
729
|
+
query_params = {}
|
730
|
+
|
731
|
+
# header parameters
|
732
|
+
header_params = {}
|
733
|
+
# HTTP header 'Accept' (if needed)
|
734
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
735
|
+
|
736
|
+
# form parameters
|
737
|
+
form_params = {}
|
738
|
+
|
739
|
+
# http body (model)
|
740
|
+
post_body = @api_client.object_to_http_body(document_fields_information)
|
741
|
+
auth_names = []
|
742
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
743
|
+
:header_params => header_params,
|
744
|
+
:query_params => query_params,
|
745
|
+
:form_params => form_params,
|
746
|
+
:body => post_body,
|
747
|
+
:auth_names => auth_names,
|
748
|
+
:return_type => 'DocumentFieldsInformation')
|
749
|
+
if @api_client.config.debugging
|
750
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
751
|
+
end
|
752
|
+
return data, status_code, headers
|
753
|
+
end
|
754
|
+
|
755
|
+
# Deletes a page from a document in an template.
|
756
|
+
# Deletes a page from a document in a template based on the page number.
|
757
|
+
# @param account_id The external account number (int) or account ID Guid.
|
758
|
+
# @param document_id The ID of the document being accessed.
|
759
|
+
# @param page_number The page number being accessed.
|
760
|
+
# @param template_id The ID of the template being accessed.
|
761
|
+
# @param page_request (optional parameter)
|
762
|
+
# @return [nil]
|
763
|
+
def delete_document_page(account_id, document_id, page_number, template_id, page_request)
|
764
|
+
delete_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request)
|
765
|
+
return nil
|
766
|
+
end
|
767
|
+
|
768
|
+
# Deletes a page from a document in an template.
|
769
|
+
# Deletes a page from a document in a template based on the page number.
|
770
|
+
# @param account_id The external account number (int) or account ID Guid.
|
771
|
+
# @param document_id The ID of the document being accessed.
|
772
|
+
# @param page_number The page number being accessed.
|
773
|
+
# @param template_id The ID of the template being accessed.
|
774
|
+
# @param page_request (optional parameter)
|
775
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
776
|
+
def delete_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request)
|
777
|
+
if @api_client.config.debugging
|
778
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_document_page ..."
|
779
|
+
end
|
780
|
+
# verify the required parameter 'account_id' is set
|
781
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_document_page" if account_id.nil?
|
782
|
+
# verify the required parameter 'document_id' is set
|
783
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.delete_document_page" if document_id.nil?
|
784
|
+
# verify the required parameter 'page_number' is set
|
785
|
+
fail ArgumentError, "Missing the required parameter 'page_number' when calling TemplatesApi.delete_document_page" if page_number.nil?
|
786
|
+
# verify the required parameter 'template_id' is set
|
787
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_document_page" if template_id.nil?
|
788
|
+
# resource path
|
789
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
790
|
+
|
791
|
+
# query parameters
|
792
|
+
query_params = {}
|
793
|
+
|
794
|
+
# header parameters
|
795
|
+
header_params = {}
|
796
|
+
# HTTP header 'Accept' (if needed)
|
797
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
798
|
+
|
799
|
+
# form parameters
|
800
|
+
form_params = {}
|
801
|
+
|
802
|
+
# http body (model)
|
803
|
+
post_body = @api_client.object_to_http_body(page_request)
|
804
|
+
auth_names = []
|
805
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
806
|
+
:header_params => header_params,
|
807
|
+
:query_params => query_params,
|
808
|
+
:form_params => form_params,
|
809
|
+
:body => post_body,
|
810
|
+
:auth_names => auth_names)
|
811
|
+
if @api_client.config.debugging
|
812
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_document_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
813
|
+
end
|
814
|
+
return data, status_code, headers
|
815
|
+
end
|
816
|
+
|
817
|
+
# Deletes documents from a template.
|
818
|
+
# Deletes one or more documents from an existing template.
|
819
|
+
# @param account_id The external account number (int) or account ID Guid.
|
820
|
+
# @param template_id The ID of the template being accessed.
|
821
|
+
# @param envelope_definition (optional parameter)
|
822
|
+
# @return [TemplateDocumentsResult]
|
823
|
+
def delete_documents(account_id, template_id, envelope_definition)
|
824
|
+
data, _status_code, _headers = delete_documents_with_http_info(account_id, template_id, envelope_definition)
|
825
|
+
return data
|
826
|
+
end
|
827
|
+
|
828
|
+
# Deletes documents from a template.
|
829
|
+
# Deletes one or more documents from an existing template.
|
830
|
+
# @param account_id The external account number (int) or account ID Guid.
|
831
|
+
# @param template_id The ID of the template being accessed.
|
832
|
+
# @param envelope_definition (optional parameter)
|
833
|
+
# @return [Array<(TemplateDocumentsResult, Fixnum, Hash)>] TemplateDocumentsResult data, response status code and response headers
|
834
|
+
def delete_documents_with_http_info(account_id, template_id, envelope_definition)
|
835
|
+
if @api_client.config.debugging
|
836
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_documents ..."
|
837
|
+
end
|
838
|
+
# verify the required parameter 'account_id' is set
|
839
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_documents" if account_id.nil?
|
840
|
+
# verify the required parameter 'template_id' is set
|
841
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_documents" if template_id.nil?
|
842
|
+
# resource path
|
843
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
844
|
+
|
845
|
+
# query parameters
|
846
|
+
query_params = {}
|
847
|
+
|
848
|
+
# header parameters
|
849
|
+
header_params = {}
|
850
|
+
# HTTP header 'Accept' (if needed)
|
851
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
852
|
+
|
853
|
+
# form parameters
|
854
|
+
form_params = {}
|
855
|
+
|
856
|
+
# http body (model)
|
857
|
+
post_body = @api_client.object_to_http_body(envelope_definition)
|
858
|
+
auth_names = []
|
859
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
860
|
+
:header_params => header_params,
|
861
|
+
:query_params => query_params,
|
862
|
+
:form_params => form_params,
|
863
|
+
:body => post_body,
|
864
|
+
:auth_names => auth_names,
|
865
|
+
:return_type => 'TemplateDocumentsResult')
|
866
|
+
if @api_client.config.debugging
|
867
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
868
|
+
end
|
869
|
+
return data, status_code, headers
|
870
|
+
end
|
871
|
+
|
872
|
+
# Removes a member group's sharing permissions for a template.
|
873
|
+
# Removes a member group's sharing permissions for a specified template.
|
874
|
+
# @param account_id The external account number (int) or account ID Guid.
|
875
|
+
# @param template_id The ID of the template being accessed.
|
876
|
+
# @param template_part Currently, the only defined part is **groups**.
|
877
|
+
# @param group_information (optional parameter)
|
878
|
+
# @return [GroupInformation]
|
879
|
+
def delete_group_share(account_id, template_id, template_part, group_information)
|
880
|
+
data, _status_code, _headers = delete_group_share_with_http_info(account_id, template_id, template_part, group_information)
|
881
|
+
return data
|
882
|
+
end
|
883
|
+
|
884
|
+
# Removes a member group's sharing permissions for a template.
|
885
|
+
# Removes a member group's sharing permissions for a specified template.
|
886
|
+
# @param account_id The external account number (int) or account ID Guid.
|
887
|
+
# @param template_id The ID of the template being accessed.
|
888
|
+
# @param template_part Currently, the only defined part is **groups**.
|
889
|
+
# @param group_information (optional parameter)
|
890
|
+
# @return [Array<(GroupInformation, Fixnum, Hash)>] GroupInformation data, response status code and response headers
|
891
|
+
def delete_group_share_with_http_info(account_id, template_id, template_part, group_information)
|
892
|
+
if @api_client.config.debugging
|
893
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_group_share ..."
|
894
|
+
end
|
895
|
+
# verify the required parameter 'account_id' is set
|
896
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_group_share" if account_id.nil?
|
897
|
+
# verify the required parameter 'template_id' is set
|
898
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_group_share" if template_id.nil?
|
899
|
+
# verify the required parameter 'template_part' is set
|
900
|
+
fail ArgumentError, "Missing the required parameter 'template_part' when calling TemplatesApi.delete_group_share" if template_part.nil?
|
901
|
+
# resource path
|
902
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/{templatePart}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'templatePart' + '}', template_part.to_s)
|
903
|
+
|
904
|
+
# query parameters
|
905
|
+
query_params = {}
|
906
|
+
|
907
|
+
# header parameters
|
908
|
+
header_params = {}
|
909
|
+
# HTTP header 'Accept' (if needed)
|
910
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
911
|
+
|
912
|
+
# form parameters
|
913
|
+
form_params = {}
|
914
|
+
|
915
|
+
# http body (model)
|
916
|
+
post_body = @api_client.object_to_http_body(group_information)
|
917
|
+
auth_names = []
|
918
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
919
|
+
:header_params => header_params,
|
920
|
+
:query_params => query_params,
|
921
|
+
:form_params => form_params,
|
922
|
+
:body => post_body,
|
923
|
+
:auth_names => auth_names,
|
924
|
+
:return_type => 'GroupInformation')
|
925
|
+
if @api_client.config.debugging
|
926
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_group_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
927
|
+
end
|
928
|
+
return data, status_code, headers
|
929
|
+
end
|
930
|
+
|
931
|
+
# Deletes a template lock.
|
932
|
+
# Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
|
933
|
+
# @param account_id The external account number (int) or account ID Guid.
|
934
|
+
# @param template_id The ID of the template being accessed.
|
935
|
+
# @param lock_request (optional parameter)
|
936
|
+
# @return [LockInformation]
|
937
|
+
def delete_lock(account_id, template_id, lock_request)
|
938
|
+
data, _status_code, _headers = delete_lock_with_http_info(account_id, template_id, lock_request)
|
939
|
+
return data
|
940
|
+
end
|
941
|
+
|
942
|
+
# Deletes a template lock.
|
943
|
+
# Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.
|
944
|
+
# @param account_id The external account number (int) or account ID Guid.
|
945
|
+
# @param template_id The ID of the template being accessed.
|
946
|
+
# @param lock_request (optional parameter)
|
947
|
+
# @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
|
948
|
+
def delete_lock_with_http_info(account_id, template_id, lock_request)
|
949
|
+
if @api_client.config.debugging
|
950
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_lock ..."
|
951
|
+
end
|
952
|
+
# verify the required parameter 'account_id' is set
|
953
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_lock" if account_id.nil?
|
954
|
+
# verify the required parameter 'template_id' is set
|
955
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_lock" if template_id.nil?
|
956
|
+
# resource path
|
957
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
958
|
+
|
959
|
+
# query parameters
|
960
|
+
query_params = {}
|
961
|
+
|
962
|
+
# header parameters
|
963
|
+
header_params = {}
|
964
|
+
# HTTP header 'Accept' (if needed)
|
965
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
966
|
+
|
967
|
+
# form parameters
|
968
|
+
form_params = {}
|
969
|
+
|
970
|
+
# http body (model)
|
971
|
+
post_body = @api_client.object_to_http_body(lock_request)
|
972
|
+
auth_names = []
|
973
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
974
|
+
:header_params => header_params,
|
975
|
+
:query_params => query_params,
|
976
|
+
:form_params => form_params,
|
977
|
+
:body => post_body,
|
978
|
+
:auth_names => auth_names,
|
979
|
+
:return_type => 'LockInformation')
|
980
|
+
if @api_client.config.debugging
|
981
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
982
|
+
end
|
983
|
+
return data, status_code, headers
|
984
|
+
end
|
985
|
+
|
986
|
+
# Deletes the specified recipient file from a template.
|
987
|
+
# Deletes the specified recipient file from the specified template.
|
988
|
+
# @param account_id The external account number (int) or account ID Guid.
|
989
|
+
# @param recipient_id The ID of the recipient being accessed.
|
990
|
+
# @param template_id The ID of the template being accessed.
|
991
|
+
# @param template_recipients (optional parameter)
|
992
|
+
# @return [Recipients]
|
993
|
+
def delete_recipient(account_id, recipient_id, template_id, template_recipients)
|
994
|
+
data, _status_code, _headers = delete_recipient_with_http_info(account_id, recipient_id, template_id, template_recipients)
|
995
|
+
return data
|
996
|
+
end
|
997
|
+
|
998
|
+
# Deletes the specified recipient file from a template.
|
999
|
+
# Deletes the specified recipient file from the specified template.
|
1000
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1001
|
+
# @param recipient_id The ID of the recipient being accessed.
|
1002
|
+
# @param template_id The ID of the template being accessed.
|
1003
|
+
# @param template_recipients (optional parameter)
|
1004
|
+
# @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
|
1005
|
+
def delete_recipient_with_http_info(account_id, recipient_id, template_id, template_recipients)
|
1006
|
+
if @api_client.config.debugging
|
1007
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_recipient ..."
|
1008
|
+
end
|
1009
|
+
# verify the required parameter 'account_id' is set
|
1010
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_recipient" if account_id.nil?
|
1011
|
+
# verify the required parameter 'recipient_id' is set
|
1012
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.delete_recipient" if recipient_id.nil?
|
1013
|
+
# verify the required parameter 'template_id' is set
|
1014
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_recipient" if template_id.nil?
|
1015
|
+
# resource path
|
1016
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1017
|
+
|
1018
|
+
# query parameters
|
1019
|
+
query_params = {}
|
1020
|
+
|
1021
|
+
# header parameters
|
1022
|
+
header_params = {}
|
1023
|
+
# HTTP header 'Accept' (if needed)
|
1024
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1025
|
+
|
1026
|
+
# form parameters
|
1027
|
+
form_params = {}
|
1028
|
+
|
1029
|
+
# http body (model)
|
1030
|
+
post_body = @api_client.object_to_http_body(template_recipients)
|
1031
|
+
auth_names = []
|
1032
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1033
|
+
:header_params => header_params,
|
1034
|
+
:query_params => query_params,
|
1035
|
+
:form_params => form_params,
|
1036
|
+
:body => post_body,
|
1037
|
+
:auth_names => auth_names,
|
1038
|
+
:return_type => 'Recipients')
|
1039
|
+
if @api_client.config.debugging
|
1040
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1041
|
+
end
|
1042
|
+
return data, status_code, headers
|
1043
|
+
end
|
1044
|
+
|
1045
|
+
# Deletes recipients from a template.
|
1046
|
+
# Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.
|
1047
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1048
|
+
# @param template_id The ID of the template being accessed.
|
1049
|
+
# @param template_recipients (optional parameter)
|
1050
|
+
# @return [Recipients]
|
1051
|
+
def delete_recipients(account_id, template_id, template_recipients)
|
1052
|
+
data, _status_code, _headers = delete_recipients_with_http_info(account_id, template_id, template_recipients)
|
1053
|
+
return data
|
1054
|
+
end
|
1055
|
+
|
1056
|
+
# Deletes recipients from a template.
|
1057
|
+
# Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.
|
1058
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1059
|
+
# @param template_id The ID of the template being accessed.
|
1060
|
+
# @param template_recipients (optional parameter)
|
1061
|
+
# @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
|
1062
|
+
def delete_recipients_with_http_info(account_id, template_id, template_recipients)
|
1063
|
+
if @api_client.config.debugging
|
1064
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_recipients ..."
|
1065
|
+
end
|
1066
|
+
# verify the required parameter 'account_id' is set
|
1067
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_recipients" if account_id.nil?
|
1068
|
+
# verify the required parameter 'template_id' is set
|
1069
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_recipients" if template_id.nil?
|
1070
|
+
# resource path
|
1071
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1072
|
+
|
1073
|
+
# query parameters
|
1074
|
+
query_params = {}
|
1075
|
+
|
1076
|
+
# header parameters
|
1077
|
+
header_params = {}
|
1078
|
+
# HTTP header 'Accept' (if needed)
|
1079
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1080
|
+
|
1081
|
+
# form parameters
|
1082
|
+
form_params = {}
|
1083
|
+
|
1084
|
+
# http body (model)
|
1085
|
+
post_body = @api_client.object_to_http_body(template_recipients)
|
1086
|
+
auth_names = []
|
1087
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1088
|
+
:header_params => header_params,
|
1089
|
+
:query_params => query_params,
|
1090
|
+
:form_params => form_params,
|
1091
|
+
:body => post_body,
|
1092
|
+
:auth_names => auth_names,
|
1093
|
+
:return_type => 'Recipients')
|
1094
|
+
if @api_client.config.debugging
|
1095
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1096
|
+
end
|
1097
|
+
return data, status_code, headers
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# Deletes the tabs associated with a recipient in a template.
|
1101
|
+
# Deletes one or more tabs associated with a recipient in a template.
|
1102
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1103
|
+
# @param recipient_id The ID of the recipient being accessed.
|
1104
|
+
# @param template_id The ID of the template being accessed.
|
1105
|
+
# @param template_tabs (optional parameter)
|
1106
|
+
# @return [Tabs]
|
1107
|
+
def delete_tabs(account_id, recipient_id, template_id, template_tabs)
|
1108
|
+
data, _status_code, _headers = delete_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs)
|
1109
|
+
return data
|
1110
|
+
end
|
1111
|
+
|
1112
|
+
# Deletes the tabs associated with a recipient in a template.
|
1113
|
+
# Deletes one or more tabs associated with a recipient in a template.
|
1114
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1115
|
+
# @param recipient_id The ID of the recipient being accessed.
|
1116
|
+
# @param template_id The ID of the template being accessed.
|
1117
|
+
# @param template_tabs (optional parameter)
|
1118
|
+
# @return [Array<(Tabs, Fixnum, Hash)>] Tabs data, response status code and response headers
|
1119
|
+
def delete_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs)
|
1120
|
+
if @api_client.config.debugging
|
1121
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_tabs ..."
|
1122
|
+
end
|
1123
|
+
# verify the required parameter 'account_id' is set
|
1124
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_tabs" if account_id.nil?
|
1125
|
+
# verify the required parameter 'recipient_id' is set
|
1126
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.delete_tabs" if recipient_id.nil?
|
1127
|
+
# verify the required parameter 'template_id' is set
|
1128
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_tabs" if template_id.nil?
|
1129
|
+
# resource path
|
1130
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1131
|
+
|
1132
|
+
# query parameters
|
1133
|
+
query_params = {}
|
1134
|
+
|
1135
|
+
# header parameters
|
1136
|
+
header_params = {}
|
1137
|
+
# HTTP header 'Accept' (if needed)
|
1138
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1139
|
+
|
1140
|
+
# form parameters
|
1141
|
+
form_params = {}
|
1142
|
+
|
1143
|
+
# http body (model)
|
1144
|
+
post_body = @api_client.object_to_http_body(template_tabs)
|
1145
|
+
auth_names = []
|
1146
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1147
|
+
:header_params => header_params,
|
1148
|
+
:query_params => query_params,
|
1149
|
+
:form_params => form_params,
|
1150
|
+
:body => post_body,
|
1151
|
+
:auth_names => auth_names,
|
1152
|
+
:return_type => 'Tabs')
|
1153
|
+
if @api_client.config.debugging
|
1154
|
+
@api_client.config.logger.debug "API called: TemplatesApi#delete_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1155
|
+
end
|
1156
|
+
return data, status_code, headers
|
1157
|
+
end
|
1158
|
+
|
1159
|
+
# Gets a list of templates for a specified account.
|
1160
|
+
# Retrieves the definition of the specified template.
|
1161
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1162
|
+
# @param template_id The ID of the template being accessed.
|
1163
|
+
# @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
|
1164
|
+
# @return [EnvelopeTemplate]
|
1165
|
+
def get(account_id, template_id, options = DocuSign_eSign::GetOptions.default)
|
1166
|
+
data, _status_code, _headers = get_with_http_info(account_id, template_id, options)
|
1167
|
+
return data
|
1168
|
+
end
|
1169
|
+
|
1170
|
+
# Gets a list of templates for a specified account.
|
1171
|
+
# Retrieves the definition of the specified template.
|
1172
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1173
|
+
# @param template_id The ID of the template being accessed.
|
1174
|
+
# @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
|
1175
|
+
# @return [Array<(EnvelopeTemplate, Fixnum, Hash)>] EnvelopeTemplate data, response status code and response headers
|
1176
|
+
def get_with_http_info(account_id, template_id, options = DocuSign_eSign::GetOptions.default)
|
1177
|
+
if @api_client.config.debugging
|
1178
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.get ..."
|
1179
|
+
end
|
1180
|
+
# verify the required parameter 'account_id' is set
|
1181
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get" if account_id.nil?
|
1182
|
+
# verify the required parameter 'template_id' is set
|
1183
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get" if template_id.nil?
|
1184
|
+
# resource path
|
1185
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1186
|
+
|
1187
|
+
# query parameters
|
1188
|
+
query_params = {}
|
1189
|
+
query_params[:'include'] = options.include if !options.include.nil?
|
1190
|
+
|
1191
|
+
# header parameters
|
1192
|
+
header_params = {}
|
1193
|
+
# HTTP header 'Accept' (if needed)
|
1194
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1195
|
+
|
1196
|
+
# form parameters
|
1197
|
+
form_params = {}
|
1198
|
+
|
1199
|
+
# http body (model)
|
1200
|
+
post_body = nil
|
1201
|
+
auth_names = []
|
1202
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1203
|
+
:header_params => header_params,
|
1204
|
+
:query_params => query_params,
|
1205
|
+
:form_params => form_params,
|
1206
|
+
:body => post_body,
|
1207
|
+
:auth_names => auth_names,
|
1208
|
+
:return_type => 'EnvelopeTemplate')
|
1209
|
+
if @api_client.config.debugging
|
1210
|
+
@api_client.config.logger.debug "API called: TemplatesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1211
|
+
end
|
1212
|
+
return data, status_code, headers
|
1213
|
+
end
|
1214
|
+
|
1215
|
+
# Gets PDF documents from a template.
|
1216
|
+
# Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.
|
1217
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1218
|
+
# @param document_id The ID of the document being accessed.
|
1219
|
+
# @param template_id The ID of the template being accessed.
|
1220
|
+
# @param DocuSign_eSign::GetDocumentOptions Options for modifying the behavior of the function.
|
1221
|
+
# @return [File]
|
1222
|
+
def get_document(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentOptions.default)
|
1223
|
+
data, _status_code, _headers = get_document_with_http_info(account_id, document_id, template_id, options)
|
1224
|
+
return data
|
1225
|
+
end
|
1226
|
+
|
1227
|
+
# Gets PDF documents from a template.
|
1228
|
+
# Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf.
|
1229
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1230
|
+
# @param document_id The ID of the document being accessed.
|
1231
|
+
# @param template_id The ID of the template being accessed.
|
1232
|
+
# @param DocuSign_eSign::GetDocumentOptions Options for modifying the behavior of the function.
|
1233
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
1234
|
+
def get_document_with_http_info(account_id, document_id, template_id, options = DocuSign_eSign::GetDocumentOptions.default)
|
1235
|
+
if @api_client.config.debugging
|
1236
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.get_document ..."
|
1237
|
+
end
|
1238
|
+
# verify the required parameter 'account_id' is set
|
1239
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_document" if account_id.nil?
|
1240
|
+
# verify the required parameter 'document_id' is set
|
1241
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.get_document" if document_id.nil?
|
1242
|
+
# verify the required parameter 'template_id' is set
|
1243
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_document" if template_id.nil?
|
1244
|
+
# resource path
|
1245
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1246
|
+
|
1247
|
+
# query parameters
|
1248
|
+
query_params = {}
|
1249
|
+
query_params[:'encrypt'] = options.encrypt if !options.encrypt.nil?
|
1250
|
+
query_params[:'show_changes'] = options.show_changes if !options.show_changes.nil?
|
1251
|
+
|
1252
|
+
# header parameters
|
1253
|
+
header_params = {}
|
1254
|
+
# HTTP header 'Accept' (if needed)
|
1255
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
1256
|
+
|
1257
|
+
# form parameters
|
1258
|
+
form_params = {}
|
1259
|
+
|
1260
|
+
# http body (model)
|
1261
|
+
post_body = nil
|
1262
|
+
auth_names = []
|
1263
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1264
|
+
:header_params => header_params,
|
1265
|
+
:query_params => query_params,
|
1266
|
+
:form_params => form_params,
|
1267
|
+
:body => post_body,
|
1268
|
+
:auth_names => auth_names,
|
1269
|
+
:return_type => 'File')
|
1270
|
+
if @api_client.config.debugging
|
1271
|
+
@api_client.config.logger.debug "API called: TemplatesApi#get_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1272
|
+
end
|
1273
|
+
return data, status_code, headers
|
1274
|
+
end
|
1275
|
+
|
1276
|
+
# Gets a page image from a template for display.
|
1277
|
+
# Retrieves a page image for display from the specified template.
|
1278
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1279
|
+
# @param document_id The ID of the document being accessed.
|
1280
|
+
# @param page_number The page number being accessed.
|
1281
|
+
# @param template_id The ID of the template being accessed.
|
1282
|
+
# @param DocuSign_eSign::GetDocumentPageImageOptions Options for modifying the behavior of the function.
|
1283
|
+
# @return [File]
|
1284
|
+
def get_document_page_image(account_id, document_id, page_number, template_id, options = DocuSign_eSign::GetDocumentPageImageOptions.default)
|
1285
|
+
data, _status_code, _headers = get_document_page_image_with_http_info(account_id, document_id, page_number, template_id, options)
|
1286
|
+
return data
|
1287
|
+
end
|
1288
|
+
|
1289
|
+
# Gets a page image from a template for display.
|
1290
|
+
# Retrieves a page image for display from the specified template.
|
1291
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1292
|
+
# @param document_id The ID of the document being accessed.
|
1293
|
+
# @param page_number The page number being accessed.
|
1294
|
+
# @param template_id The ID of the template being accessed.
|
1295
|
+
# @param DocuSign_eSign::GetDocumentPageImageOptions Options for modifying the behavior of the function.
|
1296
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
1297
|
+
def get_document_page_image_with_http_info(account_id, document_id, page_number, template_id, options = DocuSign_eSign::GetDocumentPageImageOptions.default)
|
1298
|
+
if @api_client.config.debugging
|
1299
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.get_document_page_image ..."
|
1300
|
+
end
|
1301
|
+
# verify the required parameter 'account_id' is set
|
1302
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_document_page_image" if account_id.nil?
|
1303
|
+
# verify the required parameter 'document_id' is set
|
1304
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.get_document_page_image" if document_id.nil?
|
1305
|
+
# verify the required parameter 'page_number' is set
|
1306
|
+
fail ArgumentError, "Missing the required parameter 'page_number' when calling TemplatesApi.get_document_page_image" if page_number.nil?
|
1307
|
+
# verify the required parameter 'template_id' is set
|
1308
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_document_page_image" if template_id.nil?
|
1309
|
+
# resource path
|
1310
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1311
|
+
|
1312
|
+
# query parameters
|
1313
|
+
query_params = {}
|
1314
|
+
query_params[:'dpi'] = options.dpi if !options.dpi.nil?
|
1315
|
+
query_params[:'max_height'] = options.max_height if !options.max_height.nil?
|
1316
|
+
query_params[:'max_width'] = options.max_width if !options.max_width.nil?
|
1317
|
+
query_params[:'show_changes'] = options.show_changes if !options.show_changes.nil?
|
1318
|
+
|
1319
|
+
# header parameters
|
1320
|
+
header_params = {}
|
1321
|
+
# HTTP header 'Accept' (if needed)
|
1322
|
+
header_params['Accept'] = @api_client.select_header_accept(['image/png'])
|
1323
|
+
|
1324
|
+
# form parameters
|
1325
|
+
form_params = {}
|
1326
|
+
|
1327
|
+
# http body (model)
|
1328
|
+
post_body = nil
|
1329
|
+
auth_names = []
|
1330
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1331
|
+
:header_params => header_params,
|
1332
|
+
:query_params => query_params,
|
1333
|
+
:form_params => form_params,
|
1334
|
+
:body => post_body,
|
1335
|
+
:auth_names => auth_names,
|
1336
|
+
:return_type => 'File')
|
1337
|
+
if @api_client.config.debugging
|
1338
|
+
@api_client.config.logger.debug "API called: TemplatesApi#get_document_page_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1339
|
+
end
|
1340
|
+
return data, status_code, headers
|
1341
|
+
end
|
1342
|
+
|
1343
|
+
# Gets template lock information.
|
1344
|
+
# Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
|
1345
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1346
|
+
# @param template_id The ID of the template being accessed.
|
1347
|
+
# @return [LockInformation]
|
1348
|
+
def get_lock(account_id, template_id)
|
1349
|
+
data, _status_code, _headers = get_lock_with_http_info(account_id, template_id)
|
1350
|
+
return data
|
1351
|
+
end
|
1352
|
+
|
1353
|
+
# Gets template lock information.
|
1354
|
+
# Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integrator key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
|
1355
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1356
|
+
# @param template_id The ID of the template being accessed.
|
1357
|
+
# @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
|
1358
|
+
def get_lock_with_http_info(account_id, template_id)
|
1359
|
+
if @api_client.config.debugging
|
1360
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.get_lock ..."
|
1361
|
+
end
|
1362
|
+
# verify the required parameter 'account_id' is set
|
1363
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_lock" if account_id.nil?
|
1364
|
+
# verify the required parameter 'template_id' is set
|
1365
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_lock" if template_id.nil?
|
1366
|
+
# resource path
|
1367
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1368
|
+
|
1369
|
+
# query parameters
|
1370
|
+
query_params = {}
|
1371
|
+
|
1372
|
+
# header parameters
|
1373
|
+
header_params = {}
|
1374
|
+
# HTTP header 'Accept' (if needed)
|
1375
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1376
|
+
|
1377
|
+
# form parameters
|
1378
|
+
form_params = {}
|
1379
|
+
|
1380
|
+
# http body (model)
|
1381
|
+
post_body = nil
|
1382
|
+
auth_names = []
|
1383
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1384
|
+
:header_params => header_params,
|
1385
|
+
:query_params => query_params,
|
1386
|
+
:form_params => form_params,
|
1387
|
+
:body => post_body,
|
1388
|
+
:auth_names => auth_names,
|
1389
|
+
:return_type => 'LockInformation')
|
1390
|
+
if @api_client.config.debugging
|
1391
|
+
@api_client.config.logger.debug "API called: TemplatesApi#get_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1392
|
+
end
|
1393
|
+
return data, status_code, headers
|
1394
|
+
end
|
1395
|
+
|
1396
|
+
# Gets template notification information.
|
1397
|
+
# Retrieves the envelope notification, reminders and expirations, information for an existing template.
|
1398
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1399
|
+
# @param template_id The ID of the template being accessed.
|
1400
|
+
# @return [Notification]
|
1401
|
+
def get_notification_settings(account_id, template_id)
|
1402
|
+
data, _status_code, _headers = get_notification_settings_with_http_info(account_id, template_id)
|
1403
|
+
return data
|
1404
|
+
end
|
1405
|
+
|
1406
|
+
# Gets template notification information.
|
1407
|
+
# Retrieves the envelope notification, reminders and expirations, information for an existing template.
|
1408
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1409
|
+
# @param template_id The ID of the template being accessed.
|
1410
|
+
# @return [Array<(Notification, Fixnum, Hash)>] Notification data, response status code and response headers
|
1411
|
+
def get_notification_settings_with_http_info(account_id, template_id)
|
1412
|
+
if @api_client.config.debugging
|
1413
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.get_notification_settings ..."
|
1414
|
+
end
|
1415
|
+
# verify the required parameter 'account_id' is set
|
1416
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.get_notification_settings" if account_id.nil?
|
1417
|
+
# verify the required parameter 'template_id' is set
|
1418
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.get_notification_settings" if template_id.nil?
|
1419
|
+
# resource path
|
1420
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1421
|
+
|
1422
|
+
# query parameters
|
1423
|
+
query_params = {}
|
1424
|
+
|
1425
|
+
# header parameters
|
1426
|
+
header_params = {}
|
1427
|
+
# HTTP header 'Accept' (if needed)
|
1428
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1429
|
+
|
1430
|
+
# form parameters
|
1431
|
+
form_params = {}
|
1432
|
+
|
1433
|
+
# http body (model)
|
1434
|
+
post_body = nil
|
1435
|
+
auth_names = []
|
1436
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1437
|
+
:header_params => header_params,
|
1438
|
+
:query_params => query_params,
|
1439
|
+
:form_params => form_params,
|
1440
|
+
:body => post_body,
|
1441
|
+
:auth_names => auth_names,
|
1442
|
+
:return_type => 'Notification')
|
1443
|
+
if @api_client.config.debugging
|
1444
|
+
@api_client.config.logger.debug "API called: TemplatesApi#get_notification_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1445
|
+
end
|
1446
|
+
return data, status_code, headers
|
1447
|
+
end
|
1448
|
+
|
1449
|
+
# Gets the bulk recipient file from a template.
|
1450
|
+
# Retrieves the bulk recipient file information from a template that has a bulk recipient.
|
1451
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1452
|
+
# @param recipient_id The ID of the recipient being accessed.
|
1453
|
+
# @param template_id The ID of the template being accessed.
|
1454
|
+
# @param DocuSign_eSign::ListBulkRecipientsOptions Options for modifying the behavior of the function.
|
1455
|
+
# @return [BulkRecipientsResponse]
|
1456
|
+
def list_bulk_recipients(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default)
|
1457
|
+
data, _status_code, _headers = list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, options)
|
1458
|
+
return data
|
1459
|
+
end
|
1460
|
+
|
1461
|
+
# Gets the bulk recipient file from a template.
|
1462
|
+
# Retrieves the bulk recipient file information from a template that has a bulk recipient.
|
1463
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1464
|
+
# @param recipient_id The ID of the recipient being accessed.
|
1465
|
+
# @param template_id The ID of the template being accessed.
|
1466
|
+
# @param DocuSign_eSign::ListBulkRecipientsOptions Options for modifying the behavior of the function.
|
1467
|
+
# @return [Array<(BulkRecipientsResponse, Fixnum, Hash)>] BulkRecipientsResponse data, response status code and response headers
|
1468
|
+
def list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default)
|
1469
|
+
if @api_client.config.debugging
|
1470
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.list_bulk_recipients ..."
|
1471
|
+
end
|
1472
|
+
# verify the required parameter 'account_id' is set
|
1473
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_bulk_recipients" if account_id.nil?
|
1474
|
+
# verify the required parameter 'recipient_id' is set
|
1475
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.list_bulk_recipients" if recipient_id.nil?
|
1476
|
+
# verify the required parameter 'template_id' is set
|
1477
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_bulk_recipients" if template_id.nil?
|
1478
|
+
# resource path
|
1479
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1480
|
+
|
1481
|
+
# query parameters
|
1482
|
+
query_params = {}
|
1483
|
+
query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
|
1484
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
1485
|
+
|
1486
|
+
# header parameters
|
1487
|
+
header_params = {}
|
1488
|
+
# HTTP header 'Accept' (if needed)
|
1489
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1490
|
+
|
1491
|
+
# form parameters
|
1492
|
+
form_params = {}
|
1493
|
+
|
1494
|
+
# http body (model)
|
1495
|
+
post_body = nil
|
1496
|
+
auth_names = []
|
1497
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1498
|
+
:header_params => header_params,
|
1499
|
+
:query_params => query_params,
|
1500
|
+
:form_params => form_params,
|
1501
|
+
:body => post_body,
|
1502
|
+
:auth_names => auth_names,
|
1503
|
+
:return_type => 'BulkRecipientsResponse')
|
1504
|
+
if @api_client.config.debugging
|
1505
|
+
@api_client.config.logger.debug "API called: TemplatesApi#list_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1506
|
+
end
|
1507
|
+
return data, status_code, headers
|
1508
|
+
end
|
1509
|
+
|
1510
|
+
# Gets the custom document fields from a template.
|
1511
|
+
# Retrieves the custom document field information from an existing template.
|
1512
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1513
|
+
# @param template_id The ID of the template being accessed.
|
1514
|
+
# @return [CustomFields]
|
1515
|
+
def list_custom_fields(account_id, template_id)
|
1516
|
+
data, _status_code, _headers = list_custom_fields_with_http_info(account_id, template_id)
|
1517
|
+
return data
|
1518
|
+
end
|
1519
|
+
|
1520
|
+
# Gets the custom document fields from a template.
|
1521
|
+
# Retrieves the custom document field information from an existing template.
|
1522
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1523
|
+
# @param template_id The ID of the template being accessed.
|
1524
|
+
# @return [Array<(CustomFields, Fixnum, Hash)>] CustomFields data, response status code and response headers
|
1525
|
+
def list_custom_fields_with_http_info(account_id, template_id)
|
1526
|
+
if @api_client.config.debugging
|
1527
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.list_custom_fields ..."
|
1528
|
+
end
|
1529
|
+
# verify the required parameter 'account_id' is set
|
1530
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_custom_fields" if account_id.nil?
|
1531
|
+
# verify the required parameter 'template_id' is set
|
1532
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_custom_fields" if template_id.nil?
|
1533
|
+
# resource path
|
1534
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1535
|
+
|
1536
|
+
# query parameters
|
1537
|
+
query_params = {}
|
1538
|
+
|
1539
|
+
# header parameters
|
1540
|
+
header_params = {}
|
1541
|
+
# HTTP header 'Accept' (if needed)
|
1542
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1543
|
+
|
1544
|
+
# form parameters
|
1545
|
+
form_params = {}
|
1546
|
+
|
1547
|
+
# http body (model)
|
1548
|
+
post_body = nil
|
1549
|
+
auth_names = []
|
1550
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1551
|
+
:header_params => header_params,
|
1552
|
+
:query_params => query_params,
|
1553
|
+
:form_params => form_params,
|
1554
|
+
:body => post_body,
|
1555
|
+
:auth_names => auth_names,
|
1556
|
+
:return_type => 'CustomFields')
|
1557
|
+
if @api_client.config.debugging
|
1558
|
+
@api_client.config.logger.debug "API called: TemplatesApi#list_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1559
|
+
end
|
1560
|
+
return data, status_code, headers
|
1561
|
+
end
|
1562
|
+
|
1563
|
+
# Gets the custom document fields for a an existing template document.
|
1564
|
+
# Retrieves the custom document fields for an existing template document.
|
1565
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1566
|
+
# @param document_id The ID of the document being accessed.
|
1567
|
+
# @param template_id The ID of the template being accessed.
|
1568
|
+
# @return [DocumentFieldsInformation]
|
1569
|
+
def list_document_fields(account_id, document_id, template_id)
|
1570
|
+
data, _status_code, _headers = list_document_fields_with_http_info(account_id, document_id, template_id)
|
1571
|
+
return data
|
1572
|
+
end
|
1573
|
+
|
1574
|
+
# Gets the custom document fields for a an existing template document.
|
1575
|
+
# Retrieves the custom document fields for an existing template document.
|
1576
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1577
|
+
# @param document_id The ID of the document being accessed.
|
1578
|
+
# @param template_id The ID of the template being accessed.
|
1579
|
+
# @return [Array<(DocumentFieldsInformation, Fixnum, Hash)>] DocumentFieldsInformation data, response status code and response headers
|
1580
|
+
def list_document_fields_with_http_info(account_id, document_id, template_id)
|
1581
|
+
if @api_client.config.debugging
|
1582
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.list_document_fields ..."
|
1583
|
+
end
|
1584
|
+
# verify the required parameter 'account_id' is set
|
1585
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_document_fields" if account_id.nil?
|
1586
|
+
# verify the required parameter 'document_id' is set
|
1587
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.list_document_fields" if document_id.nil?
|
1588
|
+
# verify the required parameter 'template_id' is set
|
1589
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_document_fields" if template_id.nil?
|
1590
|
+
# resource path
|
1591
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1592
|
+
|
1593
|
+
# query parameters
|
1594
|
+
query_params = {}
|
1595
|
+
|
1596
|
+
# header parameters
|
1597
|
+
header_params = {}
|
1598
|
+
# HTTP header 'Accept' (if needed)
|
1599
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1600
|
+
|
1601
|
+
# form parameters
|
1602
|
+
form_params = {}
|
1603
|
+
|
1604
|
+
# http body (model)
|
1605
|
+
post_body = nil
|
1606
|
+
auth_names = []
|
1607
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1608
|
+
:header_params => header_params,
|
1609
|
+
:query_params => query_params,
|
1610
|
+
:form_params => form_params,
|
1611
|
+
:body => post_body,
|
1612
|
+
:auth_names => auth_names,
|
1613
|
+
:return_type => 'DocumentFieldsInformation')
|
1614
|
+
if @api_client.config.debugging
|
1615
|
+
@api_client.config.logger.debug "API called: TemplatesApi#list_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1616
|
+
end
|
1617
|
+
return data, status_code, headers
|
1618
|
+
end
|
1619
|
+
|
1620
|
+
# Gets a list of documents associated with a template.
|
1621
|
+
# Retrieves a list of documents associated with the specified template.
|
1622
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1623
|
+
# @param template_id The ID of the template being accessed.
|
1624
|
+
# @return [TemplateDocumentsResult]
|
1625
|
+
def list_documents(account_id, template_id)
|
1626
|
+
data, _status_code, _headers = list_documents_with_http_info(account_id, template_id)
|
1627
|
+
return data
|
1628
|
+
end
|
1629
|
+
|
1630
|
+
# Gets a list of documents associated with a template.
|
1631
|
+
# Retrieves a list of documents associated with the specified template.
|
1632
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1633
|
+
# @param template_id The ID of the template being accessed.
|
1634
|
+
# @return [Array<(TemplateDocumentsResult, Fixnum, Hash)>] TemplateDocumentsResult data, response status code and response headers
|
1635
|
+
def list_documents_with_http_info(account_id, template_id)
|
1636
|
+
if @api_client.config.debugging
|
1637
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.list_documents ..."
|
1638
|
+
end
|
1639
|
+
# verify the required parameter 'account_id' is set
|
1640
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_documents" if account_id.nil?
|
1641
|
+
# verify the required parameter 'template_id' is set
|
1642
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_documents" if template_id.nil?
|
1643
|
+
# resource path
|
1644
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1645
|
+
|
1646
|
+
# query parameters
|
1647
|
+
query_params = {}
|
1648
|
+
|
1649
|
+
# header parameters
|
1650
|
+
header_params = {}
|
1651
|
+
# HTTP header 'Accept' (if needed)
|
1652
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1653
|
+
|
1654
|
+
# form parameters
|
1655
|
+
form_params = {}
|
1656
|
+
|
1657
|
+
# http body (model)
|
1658
|
+
post_body = nil
|
1659
|
+
auth_names = []
|
1660
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1661
|
+
:header_params => header_params,
|
1662
|
+
:query_params => query_params,
|
1663
|
+
:form_params => form_params,
|
1664
|
+
:body => post_body,
|
1665
|
+
:auth_names => auth_names,
|
1666
|
+
:return_type => 'TemplateDocumentsResult')
|
1667
|
+
if @api_client.config.debugging
|
1668
|
+
@api_client.config.logger.debug "API called: TemplatesApi#list_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1669
|
+
end
|
1670
|
+
return data, status_code, headers
|
1671
|
+
end
|
1672
|
+
|
1673
|
+
# Gets recipient information from a template.
|
1674
|
+
# Retrieves the information for all recipients in the specified template.
|
1675
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1676
|
+
# @param template_id The ID of the template being accessed.
|
1677
|
+
# @param DocuSign_eSign::ListRecipientsOptions Options for modifying the behavior of the function.
|
1678
|
+
# @return [Recipients]
|
1679
|
+
def list_recipients(account_id, template_id, options = DocuSign_eSign::ListRecipientsOptions.default)
|
1680
|
+
data, _status_code, _headers = list_recipients_with_http_info(account_id, template_id, options)
|
1681
|
+
return data
|
1682
|
+
end
|
1683
|
+
|
1684
|
+
# Gets recipient information from a template.
|
1685
|
+
# Retrieves the information for all recipients in the specified template.
|
1686
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1687
|
+
# @param template_id The ID of the template being accessed.
|
1688
|
+
# @param DocuSign_eSign::ListRecipientsOptions Options for modifying the behavior of the function.
|
1689
|
+
# @return [Array<(Recipients, Fixnum, Hash)>] Recipients data, response status code and response headers
|
1690
|
+
def list_recipients_with_http_info(account_id, template_id, options = DocuSign_eSign::ListRecipientsOptions.default)
|
1691
|
+
if @api_client.config.debugging
|
1692
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.list_recipients ..."
|
1693
|
+
end
|
1694
|
+
# verify the required parameter 'account_id' is set
|
1695
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_recipients" if account_id.nil?
|
1696
|
+
# verify the required parameter 'template_id' is set
|
1697
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_recipients" if template_id.nil?
|
1698
|
+
# resource path
|
1699
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1700
|
+
|
1701
|
+
# query parameters
|
1702
|
+
query_params = {}
|
1703
|
+
query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?
|
1704
|
+
query_params[:'include_extended'] = options.include_extended if !options.include_extended.nil?
|
1705
|
+
query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
|
1706
|
+
|
1707
|
+
# header parameters
|
1708
|
+
header_params = {}
|
1709
|
+
# HTTP header 'Accept' (if needed)
|
1710
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1711
|
+
|
1712
|
+
# form parameters
|
1713
|
+
form_params = {}
|
1714
|
+
|
1715
|
+
# http body (model)
|
1716
|
+
post_body = nil
|
1717
|
+
auth_names = []
|
1718
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1719
|
+
:header_params => header_params,
|
1720
|
+
:query_params => query_params,
|
1721
|
+
:form_params => form_params,
|
1722
|
+
:body => post_body,
|
1723
|
+
:auth_names => auth_names,
|
1724
|
+
:return_type => 'Recipients')
|
1725
|
+
if @api_client.config.debugging
|
1726
|
+
@api_client.config.logger.debug "API called: TemplatesApi#list_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1727
|
+
end
|
1728
|
+
return data, status_code, headers
|
1729
|
+
end
|
1730
|
+
|
1731
|
+
# Gets the tabs information for a signer or sign-in-person recipient in a template.
|
1732
|
+
# Gets the tabs information for a signer or sign-in-person recipient in a template.
|
1733
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1734
|
+
# @param recipient_id The ID of the recipient being accessed.
|
1735
|
+
# @param template_id The ID of the template being accessed.
|
1736
|
+
# @param DocuSign_eSign::ListTabsOptions Options for modifying the behavior of the function.
|
1737
|
+
# @return [Tabs]
|
1738
|
+
def list_tabs(account_id, recipient_id, template_id, options = DocuSign_eSign::ListTabsOptions.default)
|
1739
|
+
data, _status_code, _headers = list_tabs_with_http_info(account_id, recipient_id, template_id, options)
|
1740
|
+
return data
|
1741
|
+
end
|
1742
|
+
|
1743
|
+
# Gets the tabs information for a signer or sign-in-person recipient in a template.
|
1744
|
+
# Gets the tabs information for a signer or sign-in-person recipient in a template.
|
1745
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1746
|
+
# @param recipient_id The ID of the recipient being accessed.
|
1747
|
+
# @param template_id The ID of the template being accessed.
|
1748
|
+
# @param DocuSign_eSign::ListTabsOptions Options for modifying the behavior of the function.
|
1749
|
+
# @return [Array<(Tabs, Fixnum, Hash)>] Tabs data, response status code and response headers
|
1750
|
+
def list_tabs_with_http_info(account_id, recipient_id, template_id, options = DocuSign_eSign::ListTabsOptions.default)
|
1751
|
+
if @api_client.config.debugging
|
1752
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.list_tabs ..."
|
1753
|
+
end
|
1754
|
+
# verify the required parameter 'account_id' is set
|
1755
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_tabs" if account_id.nil?
|
1756
|
+
# verify the required parameter 'recipient_id' is set
|
1757
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.list_tabs" if recipient_id.nil?
|
1758
|
+
# verify the required parameter 'template_id' is set
|
1759
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_tabs" if template_id.nil?
|
1760
|
+
# resource path
|
1761
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1762
|
+
|
1763
|
+
# query parameters
|
1764
|
+
query_params = {}
|
1765
|
+
query_params[:'include_anchor_tab_locations'] = options.include_anchor_tab_locations if !options.include_anchor_tab_locations.nil?
|
1766
|
+
query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
|
1767
|
+
|
1768
|
+
# header parameters
|
1769
|
+
header_params = {}
|
1770
|
+
# HTTP header 'Accept' (if needed)
|
1771
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1772
|
+
|
1773
|
+
# form parameters
|
1774
|
+
form_params = {}
|
1775
|
+
|
1776
|
+
# http body (model)
|
1777
|
+
post_body = nil
|
1778
|
+
auth_names = []
|
1779
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1780
|
+
:header_params => header_params,
|
1781
|
+
:query_params => query_params,
|
1782
|
+
:form_params => form_params,
|
1783
|
+
:body => post_body,
|
1784
|
+
:auth_names => auth_names,
|
1785
|
+
:return_type => 'Tabs')
|
1786
|
+
if @api_client.config.debugging
|
1787
|
+
@api_client.config.logger.debug "API called: TemplatesApi#list_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1788
|
+
end
|
1789
|
+
return data, status_code, headers
|
1790
|
+
end
|
1791
|
+
|
1792
|
+
# Gets the definition of a template.
|
1793
|
+
# Retrieves the list of templates for the specified account. The request can be limited to a specific folder.
|
1794
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1795
|
+
# @param DocuSign_eSign::ListTemplatesOptions Options for modifying the behavior of the function.
|
1796
|
+
# @return [EnvelopeTemplateResults]
|
1797
|
+
def list_templates(account_id, options = DocuSign_eSign::ListTemplatesOptions.default)
|
1798
|
+
data, _status_code, _headers = list_templates_with_http_info(account_id, options)
|
1799
|
+
return data
|
1800
|
+
end
|
1801
|
+
|
1802
|
+
# Gets the definition of a template.
|
1803
|
+
# Retrieves the list of templates for the specified account. The request can be limited to a specific folder.
|
1804
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1805
|
+
# @param DocuSign_eSign::ListTemplatesOptions Options for modifying the behavior of the function.
|
1806
|
+
# @return [Array<(EnvelopeTemplateResults, Fixnum, Hash)>] EnvelopeTemplateResults data, response status code and response headers
|
1807
|
+
def list_templates_with_http_info(account_id, options = DocuSign_eSign::ListTemplatesOptions.default)
|
1808
|
+
if @api_client.config.debugging
|
1809
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.list_templates ..."
|
1810
|
+
end
|
1811
|
+
# verify the required parameter 'account_id' is set
|
1812
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_templates" if account_id.nil?
|
1813
|
+
# resource path
|
1814
|
+
local_var_path = "/v2/accounts/{accountId}/templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1815
|
+
|
1816
|
+
# query parameters
|
1817
|
+
query_params = {}
|
1818
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
1819
|
+
query_params[:'folder'] = options.folder if !options.folder.nil?
|
1820
|
+
query_params[:'folder_ids'] = options.folder_ids if !options.folder_ids.nil?
|
1821
|
+
query_params[:'from_date'] = options.from_date if !options.from_date.nil?
|
1822
|
+
query_params[:'include'] = options.include if !options.include.nil?
|
1823
|
+
query_params[:'order'] = options.order if !options.order.nil?
|
1824
|
+
query_params[:'order_by'] = options.order_by if !options.order_by.nil?
|
1825
|
+
query_params[:'search_text'] = options.search_text if !options.search_text.nil?
|
1826
|
+
query_params[:'shared'] = options.shared if !options.shared.nil?
|
1827
|
+
query_params[:'shared_by_me'] = options.shared_by_me if !options.shared_by_me.nil?
|
1828
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
1829
|
+
query_params[:'to_date'] = options.to_date if !options.to_date.nil?
|
1830
|
+
query_params[:'used_from_date'] = options.used_from_date if !options.used_from_date.nil?
|
1831
|
+
query_params[:'used_to_date'] = options.used_to_date if !options.used_to_date.nil?
|
1832
|
+
query_params[:'user_filter'] = options.user_filter if !options.user_filter.nil?
|
1833
|
+
|
1834
|
+
# header parameters
|
1835
|
+
header_params = {}
|
1836
|
+
# HTTP header 'Accept' (if needed)
|
1837
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1838
|
+
|
1839
|
+
# form parameters
|
1840
|
+
form_params = {}
|
1841
|
+
|
1842
|
+
# http body (model)
|
1843
|
+
post_body = nil
|
1844
|
+
auth_names = []
|
1845
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1846
|
+
:header_params => header_params,
|
1847
|
+
:query_params => query_params,
|
1848
|
+
:form_params => form_params,
|
1849
|
+
:body => post_body,
|
1850
|
+
:auth_names => auth_names,
|
1851
|
+
:return_type => 'EnvelopeTemplateResults')
|
1852
|
+
if @api_client.config.debugging
|
1853
|
+
@api_client.config.logger.debug "API called: TemplatesApi#list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1854
|
+
end
|
1855
|
+
return data, status_code, headers
|
1856
|
+
end
|
1857
|
+
|
1858
|
+
# Rotates page image from a template for display.
|
1859
|
+
# Rotates page image from a template for display. The page image can be rotated to the left or right.
|
1860
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1861
|
+
# @param document_id The ID of the document being accessed.
|
1862
|
+
# @param page_number The page number being accessed.
|
1863
|
+
# @param template_id The ID of the template being accessed.
|
1864
|
+
# @param page_request (optional parameter)
|
1865
|
+
# @return [nil]
|
1866
|
+
def rotate_document_page(account_id, document_id, page_number, template_id, page_request)
|
1867
|
+
rotate_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request)
|
1868
|
+
return nil
|
1869
|
+
end
|
1870
|
+
|
1871
|
+
# Rotates page image from a template for display.
|
1872
|
+
# Rotates page image from a template for display. The page image can be rotated to the left or right.
|
1873
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1874
|
+
# @param document_id The ID of the document being accessed.
|
1875
|
+
# @param page_number The page number being accessed.
|
1876
|
+
# @param template_id The ID of the template being accessed.
|
1877
|
+
# @param page_request (optional parameter)
|
1878
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1879
|
+
def rotate_document_page_with_http_info(account_id, document_id, page_number, template_id, page_request)
|
1880
|
+
if @api_client.config.debugging
|
1881
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.rotate_document_page ..."
|
1882
|
+
end
|
1883
|
+
# verify the required parameter 'account_id' is set
|
1884
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.rotate_document_page" if account_id.nil?
|
1885
|
+
# verify the required parameter 'document_id' is set
|
1886
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.rotate_document_page" if document_id.nil?
|
1887
|
+
# verify the required parameter 'page_number' is set
|
1888
|
+
fail ArgumentError, "Missing the required parameter 'page_number' when calling TemplatesApi.rotate_document_page" if page_number.nil?
|
1889
|
+
# verify the required parameter 'template_id' is set
|
1890
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.rotate_document_page" if template_id.nil?
|
1891
|
+
# resource path
|
1892
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1893
|
+
|
1894
|
+
# query parameters
|
1895
|
+
query_params = {}
|
1896
|
+
|
1897
|
+
# header parameters
|
1898
|
+
header_params = {}
|
1899
|
+
# HTTP header 'Accept' (if needed)
|
1900
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1901
|
+
|
1902
|
+
# form parameters
|
1903
|
+
form_params = {}
|
1904
|
+
|
1905
|
+
# http body (model)
|
1906
|
+
post_body = @api_client.object_to_http_body(page_request)
|
1907
|
+
auth_names = []
|
1908
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1909
|
+
:header_params => header_params,
|
1910
|
+
:query_params => query_params,
|
1911
|
+
:form_params => form_params,
|
1912
|
+
:body => post_body,
|
1913
|
+
:auth_names => auth_names)
|
1914
|
+
if @api_client.config.debugging
|
1915
|
+
@api_client.config.logger.debug "API called: TemplatesApi#rotate_document_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1916
|
+
end
|
1917
|
+
return data, status_code, headers
|
1918
|
+
end
|
1919
|
+
|
1920
|
+
# Updates an existing template.
|
1921
|
+
# Updates an existing template.
|
1922
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1923
|
+
# @param template_id The ID of the template being accessed.
|
1924
|
+
# @param envelope_template (optional parameter)
|
1925
|
+
# @return [TemplateUpdateSummary]
|
1926
|
+
def update(account_id, template_id, envelope_template)
|
1927
|
+
data, _status_code, _headers = update_with_http_info(account_id, template_id, envelope_template)
|
1928
|
+
return data
|
1929
|
+
end
|
1930
|
+
|
1931
|
+
# Updates an existing template.
|
1932
|
+
# Updates an existing template.
|
1933
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1934
|
+
# @param template_id The ID of the template being accessed.
|
1935
|
+
# @param envelope_template (optional parameter)
|
1936
|
+
# @return [Array<(TemplateUpdateSummary, Fixnum, Hash)>] TemplateUpdateSummary data, response status code and response headers
|
1937
|
+
def update_with_http_info(account_id, template_id, envelope_template)
|
1938
|
+
if @api_client.config.debugging
|
1939
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update ..."
|
1940
|
+
end
|
1941
|
+
# verify the required parameter 'account_id' is set
|
1942
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update" if account_id.nil?
|
1943
|
+
# verify the required parameter 'template_id' is set
|
1944
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update" if template_id.nil?
|
1945
|
+
# resource path
|
1946
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
1947
|
+
|
1948
|
+
# query parameters
|
1949
|
+
query_params = {}
|
1950
|
+
|
1951
|
+
# header parameters
|
1952
|
+
header_params = {}
|
1953
|
+
# HTTP header 'Accept' (if needed)
|
1954
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1955
|
+
|
1956
|
+
# form parameters
|
1957
|
+
form_params = {}
|
1958
|
+
|
1959
|
+
# http body (model)
|
1960
|
+
post_body = @api_client.object_to_http_body(envelope_template)
|
1961
|
+
auth_names = []
|
1962
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1963
|
+
:header_params => header_params,
|
1964
|
+
:query_params => query_params,
|
1965
|
+
:form_params => form_params,
|
1966
|
+
:body => post_body,
|
1967
|
+
:auth_names => auth_names,
|
1968
|
+
:return_type => 'TemplateUpdateSummary')
|
1969
|
+
if @api_client.config.debugging
|
1970
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1971
|
+
end
|
1972
|
+
return data, status_code, headers
|
1973
|
+
end
|
1974
|
+
|
1975
|
+
# Adds or replaces the bulk recipients list in a template.
|
1976
|
+
# Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
|
1977
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1978
|
+
# @param recipient_id The ID of the recipient being accessed.
|
1979
|
+
# @param template_id The ID of the template being accessed.
|
1980
|
+
# @param bulk_recipients_request (optional parameter)
|
1981
|
+
# @return [BulkRecipientsSummaryResponse]
|
1982
|
+
def update_bulk_recipients(account_id, recipient_id, template_id, bulk_recipients_request)
|
1983
|
+
data, _status_code, _headers = update_bulk_recipients_with_http_info(account_id, recipient_id, template_id, bulk_recipients_request)
|
1984
|
+
return data
|
1985
|
+
end
|
1986
|
+
|
1987
|
+
# Adds or replaces the bulk recipients list in a template.
|
1988
|
+
# Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
|
1989
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1990
|
+
# @param recipient_id The ID of the recipient being accessed.
|
1991
|
+
# @param template_id The ID of the template being accessed.
|
1992
|
+
# @param bulk_recipients_request (optional parameter)
|
1993
|
+
# @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
|
1994
|
+
def update_bulk_recipients_with_http_info(account_id, recipient_id, template_id, bulk_recipients_request)
|
1995
|
+
if @api_client.config.debugging
|
1996
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_bulk_recipients ..."
|
1997
|
+
end
|
1998
|
+
# verify the required parameter 'account_id' is set
|
1999
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_bulk_recipients" if account_id.nil?
|
2000
|
+
# verify the required parameter 'recipient_id' is set
|
2001
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.update_bulk_recipients" if recipient_id.nil?
|
2002
|
+
# verify the required parameter 'template_id' is set
|
2003
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_bulk_recipients" if template_id.nil?
|
2004
|
+
# resource path
|
2005
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2006
|
+
|
2007
|
+
# query parameters
|
2008
|
+
query_params = {}
|
2009
|
+
|
2010
|
+
# header parameters
|
2011
|
+
header_params = {}
|
2012
|
+
# HTTP header 'Accept' (if needed)
|
2013
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2014
|
+
|
2015
|
+
# form parameters
|
2016
|
+
form_params = {}
|
2017
|
+
|
2018
|
+
# http body (model)
|
2019
|
+
post_body = @api_client.object_to_http_body(bulk_recipients_request)
|
2020
|
+
auth_names = []
|
2021
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2022
|
+
:header_params => header_params,
|
2023
|
+
:query_params => query_params,
|
2024
|
+
:form_params => form_params,
|
2025
|
+
:body => post_body,
|
2026
|
+
:auth_names => auth_names,
|
2027
|
+
:return_type => 'BulkRecipientsSummaryResponse')
|
2028
|
+
if @api_client.config.debugging
|
2029
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2030
|
+
end
|
2031
|
+
return data, status_code, headers
|
2032
|
+
end
|
2033
|
+
|
2034
|
+
# Updates envelope custom fields in a template.
|
2035
|
+
# Updates the custom fields in a template. Each custom field used in a template must have a unique name.
|
2036
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2037
|
+
# @param template_id The ID of the template being accessed.
|
2038
|
+
# @param template_custom_fields (optional parameter)
|
2039
|
+
# @return [CustomFields]
|
2040
|
+
def update_custom_fields(account_id, template_id, template_custom_fields)
|
2041
|
+
data, _status_code, _headers = update_custom_fields_with_http_info(account_id, template_id, template_custom_fields)
|
2042
|
+
return data
|
2043
|
+
end
|
2044
|
+
|
2045
|
+
# Updates envelope custom fields in a template.
|
2046
|
+
# Updates the custom fields in a template. Each custom field used in a template must have a unique name.
|
2047
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2048
|
+
# @param template_id The ID of the template being accessed.
|
2049
|
+
# @param template_custom_fields (optional parameter)
|
2050
|
+
# @return [Array<(CustomFields, Fixnum, Hash)>] CustomFields data, response status code and response headers
|
2051
|
+
def update_custom_fields_with_http_info(account_id, template_id, template_custom_fields)
|
2052
|
+
if @api_client.config.debugging
|
2053
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_custom_fields ..."
|
2054
|
+
end
|
2055
|
+
# verify the required parameter 'account_id' is set
|
2056
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_custom_fields" if account_id.nil?
|
2057
|
+
# verify the required parameter 'template_id' is set
|
2058
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_custom_fields" if template_id.nil?
|
2059
|
+
# resource path
|
2060
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2061
|
+
|
2062
|
+
# query parameters
|
2063
|
+
query_params = {}
|
2064
|
+
|
2065
|
+
# header parameters
|
2066
|
+
header_params = {}
|
2067
|
+
# HTTP header 'Accept' (if needed)
|
2068
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2069
|
+
|
2070
|
+
# form parameters
|
2071
|
+
form_params = {}
|
2072
|
+
|
2073
|
+
# http body (model)
|
2074
|
+
post_body = @api_client.object_to_http_body(template_custom_fields)
|
2075
|
+
auth_names = []
|
2076
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2077
|
+
:header_params => header_params,
|
2078
|
+
:query_params => query_params,
|
2079
|
+
:form_params => form_params,
|
2080
|
+
:body => post_body,
|
2081
|
+
:auth_names => auth_names,
|
2082
|
+
:return_type => 'CustomFields')
|
2083
|
+
if @api_client.config.debugging
|
2084
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2085
|
+
end
|
2086
|
+
return data, status_code, headers
|
2087
|
+
end
|
2088
|
+
|
2089
|
+
# Adds a document to a template document.
|
2090
|
+
# Adds the specified document to an existing template document.
|
2091
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2092
|
+
# @param document_id The ID of the document being accessed.
|
2093
|
+
# @param template_id The ID of the template being accessed.
|
2094
|
+
# @param envelope_definition (optional parameter)
|
2095
|
+
# @param DocuSign_eSign::UpdateDocumentOptions Options for modifying the behavior of the function.
|
2096
|
+
# @return [EnvelopeDocument]
|
2097
|
+
def update_document(account_id, document_id, template_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentOptions.default)
|
2098
|
+
data, _status_code, _headers = update_document_with_http_info(account_id, document_id, template_id, envelope_definition, options)
|
2099
|
+
return data
|
2100
|
+
end
|
2101
|
+
|
2102
|
+
# Adds a document to a template document.
|
2103
|
+
# Adds the specified document to an existing template document.
|
2104
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2105
|
+
# @param document_id The ID of the document being accessed.
|
2106
|
+
# @param template_id The ID of the template being accessed.
|
2107
|
+
# @param envelope_definition (optional parameter)
|
2108
|
+
# @param DocuSign_eSign::UpdateDocumentOptions Options for modifying the behavior of the function.
|
2109
|
+
# @return [Array<(EnvelopeDocument, Fixnum, Hash)>] EnvelopeDocument data, response status code and response headers
|
2110
|
+
def update_document_with_http_info(account_id, document_id, template_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentOptions.default)
|
2111
|
+
if @api_client.config.debugging
|
2112
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_document ..."
|
2113
|
+
end
|
2114
|
+
# verify the required parameter 'account_id' is set
|
2115
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_document" if account_id.nil?
|
2116
|
+
# verify the required parameter 'document_id' is set
|
2117
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.update_document" if document_id.nil?
|
2118
|
+
# verify the required parameter 'template_id' is set
|
2119
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_document" if template_id.nil?
|
2120
|
+
# resource path
|
2121
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2122
|
+
|
2123
|
+
# query parameters
|
2124
|
+
query_params = {}
|
2125
|
+
query_params[:'apply_document_fields'] = options.apply_document_fields if !options.apply_document_fields.nil?
|
2126
|
+
query_params[:'is_envelope_definition'] = options.is_envelope_definition if !options.is_envelope_definition.nil?
|
2127
|
+
|
2128
|
+
# header parameters
|
2129
|
+
header_params = {}
|
2130
|
+
# HTTP header 'Accept' (if needed)
|
2131
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2132
|
+
|
2133
|
+
# form parameters
|
2134
|
+
form_params = {}
|
2135
|
+
|
2136
|
+
# http body (model)
|
2137
|
+
post_body = @api_client.object_to_http_body(envelope_definition)
|
2138
|
+
auth_names = []
|
2139
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2140
|
+
:header_params => header_params,
|
2141
|
+
:query_params => query_params,
|
2142
|
+
:form_params => form_params,
|
2143
|
+
:body => post_body,
|
2144
|
+
:auth_names => auth_names,
|
2145
|
+
:return_type => 'EnvelopeDocument')
|
2146
|
+
if @api_client.config.debugging
|
2147
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2148
|
+
end
|
2149
|
+
return data, status_code, headers
|
2150
|
+
end
|
2151
|
+
|
2152
|
+
# Updates existing custom document fields in an existing template document.
|
2153
|
+
# Updates existing custom document fields in an existing template document.
|
2154
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2155
|
+
# @param document_id The ID of the document being accessed.
|
2156
|
+
# @param template_id The ID of the template being accessed.
|
2157
|
+
# @param document_fields_information (optional parameter)
|
2158
|
+
# @return [DocumentFieldsInformation]
|
2159
|
+
def update_document_fields(account_id, document_id, template_id, document_fields_information)
|
2160
|
+
data, _status_code, _headers = update_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information)
|
2161
|
+
return data
|
2162
|
+
end
|
2163
|
+
|
2164
|
+
# Updates existing custom document fields in an existing template document.
|
2165
|
+
# Updates existing custom document fields in an existing template document.
|
2166
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2167
|
+
# @param document_id The ID of the document being accessed.
|
2168
|
+
# @param template_id The ID of the template being accessed.
|
2169
|
+
# @param document_fields_information (optional parameter)
|
2170
|
+
# @return [Array<(DocumentFieldsInformation, Fixnum, Hash)>] DocumentFieldsInformation data, response status code and response headers
|
2171
|
+
def update_document_fields_with_http_info(account_id, document_id, template_id, document_fields_information)
|
2172
|
+
if @api_client.config.debugging
|
2173
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_document_fields ..."
|
2174
|
+
end
|
2175
|
+
# verify the required parameter 'account_id' is set
|
2176
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_document_fields" if account_id.nil?
|
2177
|
+
# verify the required parameter 'document_id' is set
|
2178
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling TemplatesApi.update_document_fields" if document_id.nil?
|
2179
|
+
# verify the required parameter 'template_id' is set
|
2180
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_document_fields" if template_id.nil?
|
2181
|
+
# resource path
|
2182
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2183
|
+
|
2184
|
+
# query parameters
|
2185
|
+
query_params = {}
|
2186
|
+
|
2187
|
+
# header parameters
|
2188
|
+
header_params = {}
|
2189
|
+
# HTTP header 'Accept' (if needed)
|
2190
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2191
|
+
|
2192
|
+
# form parameters
|
2193
|
+
form_params = {}
|
2194
|
+
|
2195
|
+
# http body (model)
|
2196
|
+
post_body = @api_client.object_to_http_body(document_fields_information)
|
2197
|
+
auth_names = []
|
2198
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2199
|
+
:header_params => header_params,
|
2200
|
+
:query_params => query_params,
|
2201
|
+
:form_params => form_params,
|
2202
|
+
:body => post_body,
|
2203
|
+
:auth_names => auth_names,
|
2204
|
+
:return_type => 'DocumentFieldsInformation')
|
2205
|
+
if @api_client.config.debugging
|
2206
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_document_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2207
|
+
end
|
2208
|
+
return data, status_code, headers
|
2209
|
+
end
|
2210
|
+
|
2211
|
+
# Adds documents to a template document.
|
2212
|
+
# Adds one or more documents to an existing template document.
|
2213
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2214
|
+
# @param template_id The ID of the template being accessed.
|
2215
|
+
# @param envelope_definition (optional parameter)
|
2216
|
+
# @param DocuSign_eSign::UpdateDocumentsOptions Options for modifying the behavior of the function.
|
2217
|
+
# @return [TemplateDocumentsResult]
|
2218
|
+
def update_documents(account_id, template_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentsOptions.default)
|
2219
|
+
data, _status_code, _headers = update_documents_with_http_info(account_id, template_id, envelope_definition, options)
|
2220
|
+
return data
|
2221
|
+
end
|
2222
|
+
|
2223
|
+
# Adds documents to a template document.
|
2224
|
+
# Adds one or more documents to an existing template document.
|
2225
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2226
|
+
# @param template_id The ID of the template being accessed.
|
2227
|
+
# @param envelope_definition (optional parameter)
|
2228
|
+
# @param DocuSign_eSign::UpdateDocumentsOptions Options for modifying the behavior of the function.
|
2229
|
+
# @return [Array<(TemplateDocumentsResult, Fixnum, Hash)>] TemplateDocumentsResult data, response status code and response headers
|
2230
|
+
def update_documents_with_http_info(account_id, template_id, envelope_definition, options = DocuSign_eSign::UpdateDocumentsOptions.default)
|
2231
|
+
if @api_client.config.debugging
|
2232
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_documents ..."
|
2233
|
+
end
|
2234
|
+
# verify the required parameter 'account_id' is set
|
2235
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_documents" if account_id.nil?
|
2236
|
+
# verify the required parameter 'template_id' is set
|
2237
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_documents" if template_id.nil?
|
2238
|
+
# resource path
|
2239
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/documents".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2240
|
+
|
2241
|
+
# query parameters
|
2242
|
+
query_params = {}
|
2243
|
+
query_params[:'apply_document_fields'] = options.apply_document_fields if !options.apply_document_fields.nil?
|
2244
|
+
|
2245
|
+
# header parameters
|
2246
|
+
header_params = {}
|
2247
|
+
# HTTP header 'Accept' (if needed)
|
2248
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2249
|
+
|
2250
|
+
# form parameters
|
2251
|
+
form_params = {}
|
2252
|
+
|
2253
|
+
# http body (model)
|
2254
|
+
post_body = @api_client.object_to_http_body(envelope_definition)
|
2255
|
+
auth_names = []
|
2256
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2257
|
+
:header_params => header_params,
|
2258
|
+
:query_params => query_params,
|
2259
|
+
:form_params => form_params,
|
2260
|
+
:body => post_body,
|
2261
|
+
:auth_names => auth_names,
|
2262
|
+
:return_type => 'TemplateDocumentsResult')
|
2263
|
+
if @api_client.config.debugging
|
2264
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2265
|
+
end
|
2266
|
+
return data, status_code, headers
|
2267
|
+
end
|
2268
|
+
|
2269
|
+
# Shares a template with a group
|
2270
|
+
# Shares a template with the specified members group.
|
2271
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2272
|
+
# @param template_id The ID of the template being accessed.
|
2273
|
+
# @param template_part Currently, the only defined part is **groups**.
|
2274
|
+
# @param group_information (optional parameter)
|
2275
|
+
# @return [GroupInformation]
|
2276
|
+
def update_group_share(account_id, template_id, template_part, group_information)
|
2277
|
+
data, _status_code, _headers = update_group_share_with_http_info(account_id, template_id, template_part, group_information)
|
2278
|
+
return data
|
2279
|
+
end
|
2280
|
+
|
2281
|
+
# Shares a template with a group
|
2282
|
+
# Shares a template with the specified members group.
|
2283
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2284
|
+
# @param template_id The ID of the template being accessed.
|
2285
|
+
# @param template_part Currently, the only defined part is **groups**.
|
2286
|
+
# @param group_information (optional parameter)
|
2287
|
+
# @return [Array<(GroupInformation, Fixnum, Hash)>] GroupInformation data, response status code and response headers
|
2288
|
+
def update_group_share_with_http_info(account_id, template_id, template_part, group_information)
|
2289
|
+
if @api_client.config.debugging
|
2290
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_group_share ..."
|
2291
|
+
end
|
2292
|
+
# verify the required parameter 'account_id' is set
|
2293
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_group_share" if account_id.nil?
|
2294
|
+
# verify the required parameter 'template_id' is set
|
2295
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_group_share" if template_id.nil?
|
2296
|
+
# verify the required parameter 'template_part' is set
|
2297
|
+
fail ArgumentError, "Missing the required parameter 'template_part' when calling TemplatesApi.update_group_share" if template_part.nil?
|
2298
|
+
# resource path
|
2299
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/{templatePart}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s).sub('{' + 'templatePart' + '}', template_part.to_s)
|
2300
|
+
|
2301
|
+
# query parameters
|
2302
|
+
query_params = {}
|
2303
|
+
|
2304
|
+
# header parameters
|
2305
|
+
header_params = {}
|
2306
|
+
# HTTP header 'Accept' (if needed)
|
2307
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2308
|
+
|
2309
|
+
# form parameters
|
2310
|
+
form_params = {}
|
2311
|
+
|
2312
|
+
# http body (model)
|
2313
|
+
post_body = @api_client.object_to_http_body(group_information)
|
2314
|
+
auth_names = []
|
2315
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2316
|
+
:header_params => header_params,
|
2317
|
+
:query_params => query_params,
|
2318
|
+
:form_params => form_params,
|
2319
|
+
:body => post_body,
|
2320
|
+
:auth_names => auth_names,
|
2321
|
+
:return_type => 'GroupInformation')
|
2322
|
+
if @api_client.config.debugging
|
2323
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_group_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2324
|
+
end
|
2325
|
+
return data, status_code, headers
|
2326
|
+
end
|
2327
|
+
|
2328
|
+
# Updates a template lock.
|
2329
|
+
# Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
|
2330
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2331
|
+
# @param template_id The ID of the template being accessed.
|
2332
|
+
# @param lock_request (optional parameter)
|
2333
|
+
# @return [LockInformation]
|
2334
|
+
def update_lock(account_id, template_id, lock_request)
|
2335
|
+
data, _status_code, _headers = update_lock_with_http_info(account_id, template_id, lock_request)
|
2336
|
+
return data
|
2337
|
+
end
|
2338
|
+
|
2339
|
+
# Updates a template lock.
|
2340
|
+
# Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
|
2341
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2342
|
+
# @param template_id The ID of the template being accessed.
|
2343
|
+
# @param lock_request (optional parameter)
|
2344
|
+
# @return [Array<(LockInformation, Fixnum, Hash)>] LockInformation data, response status code and response headers
|
2345
|
+
def update_lock_with_http_info(account_id, template_id, lock_request)
|
2346
|
+
if @api_client.config.debugging
|
2347
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_lock ..."
|
2348
|
+
end
|
2349
|
+
# verify the required parameter 'account_id' is set
|
2350
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_lock" if account_id.nil?
|
2351
|
+
# verify the required parameter 'template_id' is set
|
2352
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_lock" if template_id.nil?
|
2353
|
+
# resource path
|
2354
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/lock".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2355
|
+
|
2356
|
+
# query parameters
|
2357
|
+
query_params = {}
|
2358
|
+
|
2359
|
+
# header parameters
|
2360
|
+
header_params = {}
|
2361
|
+
# HTTP header 'Accept' (if needed)
|
2362
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2363
|
+
|
2364
|
+
# form parameters
|
2365
|
+
form_params = {}
|
2366
|
+
|
2367
|
+
# http body (model)
|
2368
|
+
post_body = @api_client.object_to_http_body(lock_request)
|
2369
|
+
auth_names = []
|
2370
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2371
|
+
:header_params => header_params,
|
2372
|
+
:query_params => query_params,
|
2373
|
+
:form_params => form_params,
|
2374
|
+
:body => post_body,
|
2375
|
+
:auth_names => auth_names,
|
2376
|
+
:return_type => 'LockInformation')
|
2377
|
+
if @api_client.config.debugging
|
2378
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_lock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2379
|
+
end
|
2380
|
+
return data, status_code, headers
|
2381
|
+
end
|
2382
|
+
|
2383
|
+
# Updates the notification structure for an existing template.
|
2384
|
+
# Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.
|
2385
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2386
|
+
# @param template_id The ID of the template being accessed.
|
2387
|
+
# @param template_notification_request (optional parameter)
|
2388
|
+
# @return [Notification]
|
2389
|
+
def update_notification_settings(account_id, template_id, template_notification_request)
|
2390
|
+
data, _status_code, _headers = update_notification_settings_with_http_info(account_id, template_id, template_notification_request)
|
2391
|
+
return data
|
2392
|
+
end
|
2393
|
+
|
2394
|
+
# Updates the notification structure for an existing template.
|
2395
|
+
# Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.
|
2396
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2397
|
+
# @param template_id The ID of the template being accessed.
|
2398
|
+
# @param template_notification_request (optional parameter)
|
2399
|
+
# @return [Array<(Notification, Fixnum, Hash)>] Notification data, response status code and response headers
|
2400
|
+
def update_notification_settings_with_http_info(account_id, template_id, template_notification_request)
|
2401
|
+
if @api_client.config.debugging
|
2402
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_notification_settings ..."
|
2403
|
+
end
|
2404
|
+
# verify the required parameter 'account_id' is set
|
2405
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_notification_settings" if account_id.nil?
|
2406
|
+
# verify the required parameter 'template_id' is set
|
2407
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_notification_settings" if template_id.nil?
|
2408
|
+
# resource path
|
2409
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/notification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2410
|
+
|
2411
|
+
# query parameters
|
2412
|
+
query_params = {}
|
2413
|
+
|
2414
|
+
# header parameters
|
2415
|
+
header_params = {}
|
2416
|
+
# HTTP header 'Accept' (if needed)
|
2417
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2418
|
+
|
2419
|
+
# form parameters
|
2420
|
+
form_params = {}
|
2421
|
+
|
2422
|
+
# http body (model)
|
2423
|
+
post_body = @api_client.object_to_http_body(template_notification_request)
|
2424
|
+
auth_names = []
|
2425
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2426
|
+
:header_params => header_params,
|
2427
|
+
:query_params => query_params,
|
2428
|
+
:form_params => form_params,
|
2429
|
+
:body => post_body,
|
2430
|
+
:auth_names => auth_names,
|
2431
|
+
:return_type => 'Notification')
|
2432
|
+
if @api_client.config.debugging
|
2433
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_notification_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2434
|
+
end
|
2435
|
+
return data, status_code, headers
|
2436
|
+
end
|
2437
|
+
|
2438
|
+
# Updates recipients in a template.
|
2439
|
+
# Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
|
2440
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2441
|
+
# @param template_id The ID of the template being accessed.
|
2442
|
+
# @param template_recipients (optional parameter)
|
2443
|
+
# @param DocuSign_eSign::UpdateRecipientsOptions Options for modifying the behavior of the function.
|
2444
|
+
# @return [RecipientsUpdateSummary]
|
2445
|
+
def update_recipients(account_id, template_id, template_recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default)
|
2446
|
+
data, _status_code, _headers = update_recipients_with_http_info(account_id, template_id, template_recipients, options)
|
2447
|
+
return data
|
2448
|
+
end
|
2449
|
+
|
2450
|
+
# Updates recipients in a template.
|
2451
|
+
# Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
|
2452
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2453
|
+
# @param template_id The ID of the template being accessed.
|
2454
|
+
# @param template_recipients (optional parameter)
|
2455
|
+
# @param DocuSign_eSign::UpdateRecipientsOptions Options for modifying the behavior of the function.
|
2456
|
+
# @return [Array<(RecipientsUpdateSummary, Fixnum, Hash)>] RecipientsUpdateSummary data, response status code and response headers
|
2457
|
+
def update_recipients_with_http_info(account_id, template_id, template_recipients, options = DocuSign_eSign::UpdateRecipientsOptions.default)
|
2458
|
+
if @api_client.config.debugging
|
2459
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_recipients ..."
|
2460
|
+
end
|
2461
|
+
# verify the required parameter 'account_id' is set
|
2462
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_recipients" if account_id.nil?
|
2463
|
+
# verify the required parameter 'template_id' is set
|
2464
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_recipients" if template_id.nil?
|
2465
|
+
# resource path
|
2466
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2467
|
+
|
2468
|
+
# query parameters
|
2469
|
+
query_params = {}
|
2470
|
+
query_params[:'resend_envelope'] = options.resend_envelope if !options.resend_envelope.nil?
|
2471
|
+
|
2472
|
+
# header parameters
|
2473
|
+
header_params = {}
|
2474
|
+
# HTTP header 'Accept' (if needed)
|
2475
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2476
|
+
|
2477
|
+
# form parameters
|
2478
|
+
form_params = {}
|
2479
|
+
|
2480
|
+
# http body (model)
|
2481
|
+
post_body = @api_client.object_to_http_body(template_recipients)
|
2482
|
+
auth_names = []
|
2483
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2484
|
+
:header_params => header_params,
|
2485
|
+
:query_params => query_params,
|
2486
|
+
:form_params => form_params,
|
2487
|
+
:body => post_body,
|
2488
|
+
:auth_names => auth_names,
|
2489
|
+
:return_type => 'RecipientsUpdateSummary')
|
2490
|
+
if @api_client.config.debugging
|
2491
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2492
|
+
end
|
2493
|
+
return data, status_code, headers
|
2494
|
+
end
|
2495
|
+
|
2496
|
+
# Updates the tabs for a recipient.
|
2497
|
+
# Updates one or more tabs for a recipient in a template.
|
2498
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2499
|
+
# @param recipient_id The ID of the recipient being accessed.
|
2500
|
+
# @param template_id The ID of the template being accessed.
|
2501
|
+
# @param template_tabs (optional parameter)
|
2502
|
+
# @return [Tabs]
|
2503
|
+
def update_tabs(account_id, recipient_id, template_id, template_tabs)
|
2504
|
+
data, _status_code, _headers = update_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs)
|
2505
|
+
return data
|
2506
|
+
end
|
2507
|
+
|
2508
|
+
# Updates the tabs for a recipient.
|
2509
|
+
# Updates one or more tabs for a recipient in a template.
|
2510
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2511
|
+
# @param recipient_id The ID of the recipient being accessed.
|
2512
|
+
# @param template_id The ID of the template being accessed.
|
2513
|
+
# @param template_tabs (optional parameter)
|
2514
|
+
# @return [Array<(Tabs, Fixnum, Hash)>] Tabs data, response status code and response headers
|
2515
|
+
def update_tabs_with_http_info(account_id, recipient_id, template_id, template_tabs)
|
2516
|
+
if @api_client.config.debugging
|
2517
|
+
@api_client.config.logger.debug "Calling API: TemplatesApi.update_tabs ..."
|
2518
|
+
end
|
2519
|
+
# verify the required parameter 'account_id' is set
|
2520
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_tabs" if account_id.nil?
|
2521
|
+
# verify the required parameter 'recipient_id' is set
|
2522
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.update_tabs" if recipient_id.nil?
|
2523
|
+
# verify the required parameter 'template_id' is set
|
2524
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_tabs" if template_id.nil?
|
2525
|
+
# resource path
|
2526
|
+
local_var_path = "/v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
2527
|
+
|
2528
|
+
# query parameters
|
2529
|
+
query_params = {}
|
2530
|
+
|
2531
|
+
# header parameters
|
2532
|
+
header_params = {}
|
2533
|
+
# HTTP header 'Accept' (if needed)
|
2534
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2535
|
+
|
2536
|
+
# form parameters
|
2537
|
+
form_params = {}
|
2538
|
+
|
2539
|
+
# http body (model)
|
2540
|
+
post_body = @api_client.object_to_http_body(template_tabs)
|
2541
|
+
auth_names = []
|
2542
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2543
|
+
:header_params => header_params,
|
2544
|
+
:query_params => query_params,
|
2545
|
+
:form_params => form_params,
|
2546
|
+
:body => post_body,
|
2547
|
+
:auth_names => auth_names,
|
2548
|
+
:return_type => 'Tabs')
|
2549
|
+
if @api_client.config.debugging
|
2550
|
+
@api_client.config.logger.debug "API called: TemplatesApi#update_tabs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2551
|
+
end
|
2552
|
+
return data, status_code, headers
|
2553
|
+
end
|
2554
|
+
end
|
2555
|
+
end
|